Skip to main content

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

Project description

https://badge.fury.io/py/oct2py.png/ https://pypip.in/d/oct2py/badge.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(TM), 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. On Windows, the easiest way to get Octave is to use an installer from SourceForge. You must have the Numpy and Scipy libraries installed. On Linux, it should be available from your package manager. You can specify the path to your Octave executable by creating an OCTAVE_EXECUTABLE environmental variable.

To install Oct2Py, simply:

$ pip install oct2py

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

$ conda config --add channels conda-forge  # if not already added
$ conda install 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.6.1.tar.gz (937.7 kB view details)

Uploaded Source

Built Distribution

oct2py-3.6.1-py2.py3-none-any.whl (41.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for oct2py-3.6.1.tar.gz
Algorithm Hash digest
SHA256 5063ec6b306971dcf6be0980f10dc2576a7f67b2538ee1a965adc1b33b207d91
MD5 662df543361afab157921528b781c58a
BLAKE2b-256 1b5986546881f5280e90e2612d1d08d4925ea21366b350fa687f50bfd24862a5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oct2py-3.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d3dc5bd8939d912b9c06be217b7d443ef93ba90bd21f81207d7e6b91b9132402
MD5 ee614889a1648f577249c11afbc9b39f
BLAKE2b-256 6bfe1f9d5ed32e5b298b9561e32e4e5fed62c6647baf2abe34f98f294550a625

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