Skip to main content

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

Project description

https://badge.fury.io/py/oct2py.png/ https://coveralls.io/repos/blink1073/oct2py/badge.png?branch=master

Oct2Py is a means 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 with arbitrary nesting.

  • Supports sparse matrices.

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

  • Nargout is automatically inferred by the number of return variables.

  • 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 3.6 or newer 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-3.9.2.tar.gz (771.9 kB view details)

Uploaded Source

Built Distribution

oct2py-3.9.2-py2.py3-none-any.whl (38.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for oct2py-3.9.2.tar.gz
Algorithm Hash digest
SHA256 6c068889ff02f4bf938bb703348fb381ce2884dca1bda4b7f751e70b1fa9ff8f
MD5 c957e42ebc6e50f4f0310fa2b0fdfc5c
BLAKE2b-256 97f90d6fe6fb9a389cf88a54643d7fab688cb24b1459fb9108c75680af5cf54c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oct2py-3.9.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6792aa255e85e055babd2954b591caabd2df216937079c7a1828f2d19478f63f
MD5 58f60e0970ca958d38a6628805e1c0d3
BLAKE2b-256 ae2839fd73a8cf3d7a1b58f78d1390b01eac835bf3cd741e7d19705d0ddcf0b1

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