Skip to main content

Python to GNU Octave bridge --> run m-files from python.

Project description

https://badge.fury.io/py/oct2py.png/ https://codecov.io/github/blink1073/oct2py/coverage.svg?branch=master PyPi Download stats

Oct2Py allows you to seamlessly call M-files and Octave functions from Python. It manages the Octave session for you, sharing data behind the scenes using MAT files. Usage is as simple as:

>>> oc = oct2py.Oct2Py()
>>> x = oc.zeros(3,3)
>>> print(x, x.dtype)
[[ 0.  0.  0.]
 [ 0.  0.  0.]
 [ 0.  0.  0.]] float64
...

To run .m function, you need to explicitly add the path to .m file using:

>>> from oct2py import import octave
>>> # to add a folder use:
>>> octave.addpath('/path/to/directory')
>>> # to add folder with all subfolder in it use:
>>> octave.addpath(octave.genpath('/path/to/directory'))
...

To get the output of .m file after setting the path, use:

>>> x = np.array([[1, 2], [3, 4]], dtype=float)
>>> #use nout='max_nout' to automatically choose max possible nout
>>> out, oclass = octave.roundtrip(x,nout=2)
>>> import pprint
>>> pprint.pprint([x, x.dtype, out, oclass, out.dtype])
[array([[1., 2.],
        [3., 4.]]),
    dtype('float64'),
    array([[1., 2.],
        [3., 4.]]),
    'double',
    dtype('<f8')]
...

If you want to run legacy m-files, do not have MATLAB®, and do not fully trust a code translator, this is your library.

Features

  • Supports all Octave datatypes and most Python datatypes and Numpy dtypes.

  • Provides OctaveMagic for IPython, including inline plotting in notebooks.

  • Supports cell arrays and structs/struct arrays with arbitrary nesting.

  • Supports sparse matrices.

  • Builds methods on the fly linked to Octave commands (e.g. zeros above).

  • Thread-safety: each Oct2Py object uses an independent Octave session.

  • Can be used as a context manager.

  • Supports Unicode characters.

  • Supports logging of session commands.

  • Optional timeout command parameter to prevent runaway Octave sessions.

Installation

You must have GNU Octave installed and in your PATH environment variable. Alternatively, you can set an OCTAVE_EXECUTABLE or OCTAVE environment variable that points to octave-cli executable itself.

You must have the Numpy and Scipy libraries for Python installed. See the installation instructions for more details.

Once the dependencies have been installed, run:

$ pip install oct2py

If using conda, it is available on conda-forge:

$ conda install -c conda-forge oct2py

Documentation

Documentation is available online.

For version information, see the Revision History.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oct2py-5.2.0.tar.gz (436.1 kB view details)

Uploaded Source

Built Distribution

oct2py-5.2.0-py2.py3-none-any.whl (44.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file oct2py-5.2.0.tar.gz.

File metadata

  • Download URL: oct2py-5.2.0.tar.gz
  • Upload date:
  • Size: 436.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0.post20200704 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.4

File hashes

Hashes for oct2py-5.2.0.tar.gz
Algorithm Hash digest
SHA256 7e7f03724d60745b6ff49760027712a5ae22ed3c67f8d4560ba8a80c2ebdfaf0
MD5 38716dad8d0c0fab0eceb82ed4b7d219
BLAKE2b-256 48888c9d342e2c49715d2e179beb11f52e90c7872bccaaa24930b45748f77ff1

See more details on using hashes here.

Provenance

File details

Details for the file oct2py-5.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: oct2py-5.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 44.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0.post20200704 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.4

File hashes

Hashes for oct2py-5.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ef00a0c7875d9036661ac2053a11ad20dbbf37acf8421fcbf1422aba9c80d140
MD5 3ba8198f159edbf0c4de5382b2bb9548
BLAKE2b-256 c2c1c9be8ed15812948e15130f49ed58d83cddf91b92e3df87edface0626960a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page