M2JK — Jupyter kernel for Macaulay2
Beta Testing!
You can now use Jupyter (Notebook or Lab) as a front-end for Macaulay2.
See the demo for sample use and an outline of the kernel-specific features. For bugs or requests, open an issue. For recent changes, see the changelog.
Requirements
You need a recent version of Python and pip
.
Python 3 is recommended for build installs and necessary for source installs.
You can install Jupyter directly from PyPI by
pip3 install --upgrade pip
pip3 install jupyter
Macaulay2 needs to be installed and on your path.
If you are using Emacs as your front-end, it already is, but you can test it by which M2
.
Otherwise, you can achieve that by running setup()
from within an M2 session.
Alternatively, you can configure M2JK to use a specific binary.
Installation
You can install the latest release version directly from PyPI by
$ pip3 install macaulay2-jupyter-kernel
$ python3 -m m2_kernel.install
Alternatively, you can install the latest development version from source by
$ git clone https://github.com/radoslavraynov/macaulay2-jupyter-kernel.git
$ cd macaulay2-jupyter-kernel
$ pip3 install .
$ python3 -m m2_kernel.install
Running the notebook
Once the installation is complete, you need to start (or restart) Jupyter by
$ jupyter notebook &
This shoud fire up a browser for you. If not, copy the output URL into one. Then select File ⇨ New Notebook ⇨ M2 from the main menu.
License
This software is not part of Macaulay2 and is released under the MIT License.