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=main 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:

>>> import oct2py
>>> oc = oct2py.Oct2Py()
>>> x = oc.zeros(3, 3)
>>> print(x, x.dtype)
[[0. 0. 0.]
 [0. 0. 0.]
 [0. 0. 0.]] float64

To run .m function, you need to explicitly add the path to .m file using:

>>> from oct2py import octave
>>> # to add a folder use:
>>> octave.addpath("/path/to/directory")  # doctest: +SKIP
>>> # to add folder with all subfolder in it use:
>>> octave.addpath(octave.genpath("/path/to/directory"))  # doctest: +SKIP
>>> # to run the .m file :
>>> octave.run("fileName.m")  # doctest: +SKIP

To get the output of .m file after setting the path, use:

>>> import numpy as np
>>> from oct2py import octave
>>> x = np.array([[1, 2], [3, 4]], dtype=float)
>>> # use nout='max_nout' to automatically choose max possible nout
>>> octave.addpath("./example")  # doctest: +SKIP
>>> out, oclass = octave.roundtrip(x, nout=2)  # doctest: +SKIP
>>> import pprint  # doctest: +SKIP
>>> pprint.pprint([x, x.dtype, out, oclass, out.dtype])  # doctest: +SKIP
[array([[1., 2.],
        [3., 4.]]),
    dtype('float64'),
    array([[1., 2.],
        [3., 4.]]),
    'double',
    dtype('<f8')]

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

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

Uploaded Source

Built Distribution

oct2py-5.8.0-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oct2py-5.8.0.tar.gz
  • Upload date:
  • Size: 442.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for oct2py-5.8.0.tar.gz
Algorithm Hash digest
SHA256 2b5e86a9de1d62adcc90ae6795f9e33302f7eef649ce3cef671d1be8b4b5804b
MD5 c944920e4dc60ab16041fee2ce1cbadf
BLAKE2b-256 d5385c854e026d406787737b5cb5fa9c2a8b4c71bcc3f5a148825a7fdf25a023

See more details on using hashes here.

File details

Details for the file oct2py-5.8.0-py3-none-any.whl.

File metadata

  • Download URL: oct2py-5.8.0-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for oct2py-5.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e47ac977ad56c6051d5388e815e311666e12a0f4883d4f028c1c737b0fc0afe
MD5 92b84b9420b06b536465a55e8936641f
BLAKE2b-256 40acbe35f31333cfa0346aca91bdbdc8186e8e6be7364386225122395b1b8029

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page