Skip to main content

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

You can install the latest development version from source by

$ pip3 install git+https://github.com/Macaulay2/Macaulay2-Jupyter-Kernel
$ python3 -m m2_kernel install

Docker

A docker image packing the latest versions of the kernel and Macaulay2 is available as dtorrance/m2jk. To run locally, you need to map port 8890.

$ docker run -p 8890:8890 dtorrance/m2jk &

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.

Metadata

Release files for macaulay2-jupyter-kernel 0.8.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for macaulay2-jupyter-kernel 0.8.2
File Size Uploaded Provenance
macaulay2_jupyter_kernel-0.8.2.tar.gz 27.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for macaulay2-jupyter-kernel 0.8.2
File Interpreter ABI Platform
macaulay2_jupyter_kernel-0.8.2-py3-none-any.whl Python 3 none any Details

Total release size: 54.8 kB

Release files / macaulay2_jupyter_kernel-0.8.2.tar.gz

Download URL macaulay2_jupyter_kernel-0.8.2.tar.gz
Size 27.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8b078f8e21c99a9f0222da35218b0aacceb17f9b9751565a8a8192bf7cc81538
BLAKE2b-256 checksum
How to use checksums
f997409bf8445e9bdc7e011b7b62c1c05c0b3a05ab6f89728fea43c479a314cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / macaulay2_jupyter_kernel-0.8.2-py3-none-any.whl

Download URL macaulay2_jupyter_kernel-0.8.2-py3-none-any.whl
Size 27.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ddfe639d9c178a2de8c52b8ae60103f282540891572e32e73d76d4d8b578bc74
BLAKE2b-256 checksum
How to use checksums
7d6b80623c25bef9a87d9f8d6e56aeb4ba48852c46458fa06975d9bd014035ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for macaulay2-jupyter-kernel 0.8.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page