Skip to main content

'A Jupyter kernel for Scilab.'

Project description

A Jupyter kernel for Scilab

Prerequisites

Jupyter Notebook, and Scilab.

Installation

To install using pip:

pip install scilab_kernel

Add --user to install in the user-level environment instead of the system environment.

This kernel needs the Scilab executable to be run, it which will be searched in this order:
  • Using environment variable SCILAB_EXECUTABLE,

  • Under Windows only, based on registry,

  • Using the PATH environment variable.

Use the scilab-adv-cli executable if using a Posix-like OS, and WScilex-cli.exe if using Windows.

Usage

To use the kernel, run one of:

jupyter notebook  # or ``jupyter lab``, if available
# In the notebook interface, select Scilab from the 'New' menu
jupyter qtconsole --kernel scilab
jupyter console --kernel scilab

If jupyter executable is not found in your PATH, try python -m notebook instead.

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.

Configuration

The kernel can be configured by adding an scilab_kernel_config.py file to the jupyter config path (for example ~/.jupyter/scilab_kernel_config.py. The ScilabKernel class offers plot_settings as a configurable traits. The available plot settings are:

  • ‘format’: ‘svg’ (default), ‘png’, ‘jpg’,

  • ‘backend’: ‘inline’,

  • ‘size’: ‘<width>,<height>’ (‘560,420’ by default),

  • ‘antialiasing’: for ‘svg’ backend only, True by default.

c.ScilabKernel.plot_settings = dict(format='svg', backend='inline', size='560,420', antialiasing=False)

Scilab default behavior is setup using lines(0, 800) and mode(0). You can change these behaviors using scilab code on cells.

Files ending with .sci in the current directory are loaded.

Troubleshooting

Kernel Times Out While Starting

If the kernel does not start, run the following command from a terminal:

python -m scilab_kernel.check

This can help diagnose problems with setting up integration with Scilab. 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 scilab_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

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 scilab kernel, and install using python -m scilab_kernel install. See python -m scilab_kernel install --help for available options.

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

scilab_kernel-0.10.1.tar.gz (99.2 kB view details)

Uploaded Source

Built Distribution

scilab_kernel-0.10.1-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file scilab_kernel-0.10.1.tar.gz.

File metadata

  • Download URL: scilab_kernel-0.10.1.tar.gz
  • Upload date:
  • Size: 99.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.6

File hashes

Hashes for scilab_kernel-0.10.1.tar.gz
Algorithm Hash digest
SHA256 440a2c75b969becfbab5bc4c86931bbe55c7d97f429382362febf78a6105c4e7
MD5 f46130efd7aecce2e5954e96b141f165
BLAKE2b-256 ee4af981dbc8e82db55ac022768acce7b5835008c8afefc57fdb7fb87094bb51

See more details on using hashes here.

Provenance

File details

Details for the file scilab_kernel-0.10.1-py3-none-any.whl.

File metadata

File hashes

Hashes for scilab_kernel-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1e427bda529bd687d8f87c44f76dd757a12514d0ac9ea076d64aad7fc0978f39
MD5 de9bebabe895c6b26faec58c35d533f8
BLAKE2b-256 627e8e5d86a94b25fa80b4c40f07f6ceea685505a861d00f35c08fd1cb0bc030

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