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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for oct2py-3.6.0.tar.gz
Algorithm Hash digest
SHA256 b356daf63a80c778fcf81b380c187863b86e9aae88f8321bb543c5512835c69f
MD5 d6ad0d11512cc3498aae3b14cd2b9237
BLAKE2b-256 01a877e3817110bda1b22cf02d11bf77090c481ebaf81fc3a4a3cabbef719446

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oct2py-3.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b91fbe681cba6f9d169542b35fa60c2f472abedd691c0fa63a3b103f56fb8b81
MD5 a8b5d4f07e77040f0026b733a2da0ad9
BLAKE2b-256 a908381318e02a2b7faf0b408e4a89894f6719b95e8ca54bf526b9659a9153bc

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