A magma kernel for Jupyter, based on bash_kernel
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
nbruin 4418bd79d1
Amend do_help to work with JupyterLab
7 years ago
magma_kernel Amend do_help to work with JupyterLab 7 years ago
.gitignore Major rewrite 8 years ago
LICENSE Major rewrite 8 years ago
MANIFEST.in Major rewrite 8 years ago
README.rst update instructions 8 years ago
setup.py Major rewrite 8 years ago

README.rst

A simple Jupyter kernel for the Magma computer algebra system

This kernel requires that Magma is installed and runnable using the
standard path, i.e., that typing the command ``magma`` will run magma.
Furthermore, it requires Jupyter running on Py3.

If ``pip`` and ``python`` point to their Py3 versions, you can install the 
kernel as a user with the commands::

    pip install git+https://github.com/nbruin/magma_kernel --user
    python -m magma_kernel.install

On some systems you may need to use ``pip3`` and ``python3`` instead::

    pip3 install git+https://github.com/nbruin/magma_kernel --user
    python3 -m magma_kernel.install

To use it, run one of:

.. code:: shell

    jupyter notebook
    # In the notebook interface, select Magma from the 'New' menu
    jupyter qtconsole --kernel magma
    jupyter console --kernel magma

This code is based on a Magma kernel for IPython written by Christopher 
Granade, which was in turn based on the Bash example kernel by Thomas 
Kluyver. Improvements made in the current version include Tab 
completion, processing of help requests by returning an appropriate 
help query URL for Magma online documentation, and the reporting of 
partial output.