Skip to main content

No project description provided

Project description

Prerequisites

Install Jupyter Notebook and the Matlab engine for Python.

Installation

Install using:

$ pip install matlab_kernel

or pip install git+https://github.com/Calysto/matlab_kernel for the dev version.

To use the kernel, run one of:

$ jupyter notebook
# In the notebook interface, select Matlab from the 'New' menu
$ jupyter qtconsole --kernel matlab
$ jupyter console --kernel matlab

To remove from kernel listings:

$ jupyter kernelspec remove matlab

Configuration

The kernel can be configured by adding an matlab_kernel_config.py file to the jupyter config path. The MatlabKernel class offers plot_settings as a configurable traits. The available plot settings are: ‘format’, ‘backend’, ‘width’, ‘height’, and ‘resolution’.

cat ~/.jupyter/matlab_kernel_config.py
c.MatlabKernel.plot_settings = dict(format='svg')

Troubleshooting

Kernel Times Out While Starting

If the kernel is not starting, try running the following from a terminal.

python -m matlab_kernel.check

Please include that output if opening an issue.

Kernel is Not Listed

If the kernel is not listed as an available kernel, first try the following command:

python -m matlab_kernel install --user

If the kernel is still not listed, verify that the following point to the same version of python:

which python  # use "where" if using cmd.exe
which jupyter

Additional information

The Matlab kernel is based on MetaKernel, which means it features a standard set of magics. For a full list of magics, run %lsmagic in a cell.

A sample notebook is available online.

A note about plotting. After each call to Matlab, we ask Matlab to save any open figures to image files whose format and resolution are defined using the %plot magic. The resulting image is shown inline in the notebook. You can use %plot native to raise normal Matlab windows instead.

Advanced Installation Notes

We automatically install a Jupyter kernelspec when installing the python package. This location can be found using jupyter kernelspec list. If the default location is not desired, you can remove the directory for the octave kernel, and install using python -m matlab_kernel install. See python -m matlab_kernel install --help for available options.

It has been reported that Matlab version 2016b works fine. However, Matlab 2014b does not work with Python 3.5.

Development

Install the package locally:

$ pip install -e .
$ python -m matlab_kernel install

As you make changes, test them in a notebook (restart the kernel between changes).

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

matlab_kernel-0.17.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

matlab_kernel-0.17.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file matlab_kernel-0.17.0.tar.gz.

File metadata

  • Download URL: matlab_kernel-0.17.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for matlab_kernel-0.17.0.tar.gz
Algorithm Hash digest
SHA256 030f2fa23e9b02d9a92045703b8d3c115e8dcce102ac59a37037bd0c62783a37
MD5 d0ed178ca6a6da0c6170b06709425516
BLAKE2b-256 57677a2fff38439f0552a4be9e177af7f3b18dae92a2025fb816763282813d8b

See more details on using hashes here.

Provenance

File details

Details for the file matlab_kernel-0.17.0-py3-none-any.whl.

File metadata

File hashes

Hashes for matlab_kernel-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b45bf2436d77be56ded8bc547e99f5bc4ecb6e36497a1a1ff99502cc76874ccb
MD5 6e0ea969bcb1bdb75c3919fb8ab4873a
BLAKE2b-256 ce5e475317c91ae0a94f7ed5abfeb77a2b7b23151e2f5f5f530c5f962a252a67

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