Skip to main content

A Jupyter kernel for Scilab.

Project description

A Jupyter kernel for Scilab

Prerequisites
-------------
`Jupyter Notebook <http://jupyter.readthedocs.org/en/latest/install.html>`_, and `Scilab <http://www.scilab.org/download/latest>`_.

Installation
------------

pip install scilab_kernel

To use it, run one of:

.. code:: shell

ipython notebook
# In the notebook interface, select Scilab from the 'New' menu
ipython qtconsole --kernel scilab
ipython console --kernel scilab

This kernel is based on `MetaKernel <http://pypi.python.org/pypi/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_.

You can specify the path to your Scilab executable by creating a ``SCILAB_EXECUTABLE`` environmental variable. Use the ``scilab-adv-cli`` executable if using a Posix-like OS, and ``WScilex-cli.exe`` if using Windows.


Configuration
-------------
The kernel can be configured by adding an ``scilab_kernel_config.py`` file to the
``jupyter`` config path. The ``ScilabKernel`` class offers ``plot_settings`` as a configurable traits.
The available plot settings are:
'format', 'backend', 'width', 'height', and 'resolution'.

.. code:: bash
cat ~/.jupyter/scilab_kernel_config.py
# use Qt as the default backend for plots
c.ScilabKernel.plot_settings = dict(format='svg')


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

.. code
python -m scilab_kernel.check

Please include that output if opening an issue.


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.

.. _online: http://nbviewer.ipython.org/github/calysto/scilab_kernel/blob/master/scilab_kernel.ipynb


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.9.10.tar.gz (15.4 kB view hashes)

Uploaded source

Built Distribution

scilab_kernel-0.9.10-py2.py3-none-any.whl (23.3 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page