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
...

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.0.4.tar.gz (434.6 kB view details)

Uploaded Source

Built Distribution

oct2py-5.0.4-py2.py3-none-any.whl (42.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: oct2py-5.0.4.tar.gz
  • Upload date:
  • Size: 434.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for oct2py-5.0.4.tar.gz
Algorithm Hash digest
SHA256 ce3b2235698faed3811434928239bc90c9c26efdd6c6a5c7391749cf26cbd71f
MD5 ae9bcbe27a974a57cad378eff7435ae3
BLAKE2b-256 9ff6a40bca3e7c1c4a5853d50af64e9f9e1c9e7fc2ab247061d4a53fd5a1da4f

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: oct2py-5.0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 42.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for oct2py-5.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 229a6ceb2bd9e887654f87f768620446070e498b4796ed91c013f6dcb33baf81
MD5 4c93fa23f60f644500f156eecc9f8abe
BLAKE2b-256 ffe1f60e6ebb2754dbb1993c09f8a2c105b51c8d711aa2667e6a04d0434ee1d7

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