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

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

Uploaded Source

Built Distribution

oct2py-4.0.3-py2.py3-none-any.whl (42.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: oct2py-4.0.3.tar.gz
  • Upload date:
  • Size: 431.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for oct2py-4.0.3.tar.gz
Algorithm Hash digest
SHA256 eb543c6ac1a2c3a42b6ca839f19215e8de7b06f5cf3cbd6ad72323823a99c310
MD5 e1abf3dc6942fb44be29f49a02546a4c
BLAKE2b-256 6d37c0e60e96c16b3f16db1f13c6dae9c8e91897877a0c46e24a715c53b777b9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oct2py-4.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bf38a1a774335af37a63fe35644f976e7e7796389ed8a292ed96fc1a0f7b9039
MD5 6a254d6d6f0431103a14d2fe2e217b03
BLAKE2b-256 a42755f4eeb96b53bf282b110aedc8dc62aa42b473a6ed983355710f07a5d85c

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