Skip to main content

JupyterLite loader for Xeus kernels

Project description

JupyterLite Xeus

Github Actions Status

jupyterlite-xeus is an extension for JupyterLite that enables fully client-side Jupyter environments powered by xeus kernels compiled to WebAssembly (Wasm). It allows users to create statically-served Jupyter deployments with custom pre-built environments — no server required.

The core feature of jupyterlite-xeus is its integration with emscripten-forge, a conda package distribution tailored for WebAssembly. This makes it possible to bundle your favorite scientific or data analysis packages directly into the browser-based environment, delivering a reproducible computing experience with zero backend dependencies.

Ideal for demos, educational resources, and offline computing. Use it in combination with Voici!

Currently supported kernels are:

Quickstart

The easiest way to deploy your Notebooks using xeus lite kernels is through Notebook.link, try it!

Alternatively, you can use the template repository https://github.com/jupyterlite/xeus-lite-demo to quickstart your own deployment of jupyterlite on Github pages including jupyterlite-xeus.

Requirements

  • JupyterLab >= 4.0.0

Installation

You can install jupyterlite-xeus with conda/mamba

mamba install -c conda-forge jupyterlite-xeus

Or with pip (you must install micromamba 2.0.5):

pip install jupyterlite-xeus

Documentation

Learn more about jupyterlite-xeus and test our live demo on https://jupyterlite-xeus.readthedocs.io

Contributing

Development install from a conda / mamba environment

Create the conda environment with conda/mamba/micromamba (replace micromamba with conda or mamba according to your preference):

micromamba create -f environment-dev.yaml -n xeus-lite-dev

Activate the environment:

micromamba activate xeus-lite-dev
python -m pip install . -v --no-build-isolation

Then make your jupyterlite build as usual, see the JupyterLite documentation for more info

Packaging the extension

See RELEASE.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlite_xeus-4.5.2.tar.gz (10.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyterlite_xeus-4.5.2-py3-none-any.whl (9.6 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlite_xeus-4.5.2.tar.gz.

File metadata

  • Download URL: jupyterlite_xeus-4.5.2.tar.gz
  • Upload date:
  • Size: 10.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jupyterlite_xeus-4.5.2.tar.gz
Algorithm Hash digest
SHA256 294cacb7430f6f063c12857d8d5bc56e05823b670fcb03ce6a2ff0e64e2a68c8
MD5 78d6515dc1374e51eabd49edd60157de
BLAKE2b-256 53673725af296be05be97b42db589682ee25c86212d029685e997039ec1ec438

See more details on using hashes here.

File details

Details for the file jupyterlite_xeus-4.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlite_xeus-4.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3a3978744e692eaff21bff8332628dbabaf3c06d6df40c083183e77aeb53c952
MD5 bc89efecd651693c37bd74c39a50f0ad
BLAKE2b-256 5bcbcec13106869acb49e17163cf872088a38f7f80b36b38f74426f894f689ef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page