A Jupyter kernel for Octave.
Project description
Prerequisites
Jupyter Notebook and GNU Octave.
It is recommended to also install gnuplot for Octave to enable inline plotting.
Installation
To install using pip:
pip install octave_kernel
Add --user to install in the user-level environment instead of the system environment.
To install using conda:
conda config --add channels conda-forge conda install octave_kernel conda install texinfo # For the inline documentation (shift-tab) to appear.
We require the octave-cli executable to run the kernel. Add that executable’s directory to the PATH environment variable or use the OCTAVE_EXECUTABLE to point to the executable itself. Note that on Octave 5 on Windows, the executable is in "Octave-5.x.x.x\mingw64\bin".
Usage
To use the kernel, run one of:
jupyter notebook # or ``jupyter lab``, if available
# In the notebook interface, select Octave from the 'New' menu
jupyter qtconsole --kernel octave
jupyter console --kernel octave
This kernel is based on MetaKernel, which means it features a standard set of magics (such as %%html). For a full list of magics, run %lsmagic in a cell.
A sample notebook is available online.
Troubleshooting
Kernel Times Out While Starting
If the kernel does not start, run the following command from a terminal:
python -m octave_kernel.check
This can help diagnose problems with setting up integration with Octave. If in doubt, create an issue with the output of that command.
Kernel is Not Listed
If the kernel is not listed as an available kernel, first try the following command:
python -m octave_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
Gnuplot Error
An error that starts with gnuplot> set terminal aqua enhanced title can be fixed by adding setenv("GNUTERM","qt"); to ~/.octaverc on MacOS or by installing gunplot-x11 and using setenv("GNUTERM", "X11").
Advanced Configuration
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, remove the directory for the octave kernel, and install using python -m octave_kernel install. See python -m octave_kernel install --help for available options.
The path to the Octave kernel JSON file can be specified by creating an OCTAVE_KERNEL_JSON environment variable.
The command line options to Octave can be specified with an OCTAVE_CLI_OPTIONS environment variable. The will be appended to the default opions of --interactive --quiet --no-init-file. Note that the init file is explicitly called after the kernel has set more off to prevent a lockup when the pager is invoked in ~/.octaverc.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for octave_kernel-0.29.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92837bdd46d98dd3fc2bcb5bc155860782f584573764ec7a34753fa452f57b29 |
|
MD5 | fa563a811ff4c422a899ae7880f5f1be |
|
BLAKE2b-256 | 89b5e40ce89fad2b09f071d6ad652d3ac9d2659c7402d9e6c01f958fed006f21 |