Skip to content

JupyterLite Xeus

Installation

To consume emscripten-forge packages in a JupyterLite environment, the jupyterlite_xeus package needs to be installed. This can be done with pip

pip install jupyterlite_xeus
or conda/mamba/micromamba

mamba install jupyterlite-xeus

Usage

Note

Emscripten-forge provides xeus kernels for multiple languages, this document focuses on the Python kernel, namely xeus-python. While the other kernels can also be installed as described below, adding custom packages is only supported for the xeus-python kernel at the moment.

From environment file

To load a xeus-python kernel with a custom environment, create an environment.yaml file with xeus-python and the desired dependencies. Here is an example with numpy as a additional dependency: 

name: xeus-lite-wasm
channels:
  - https://repo.mamba.pm/emscripten-forge
  - conda-forge
dependencies:
  - xeus-python
  - numpy

To build JupyterLite, run the following command where environment.yaml is the path to the file you just created

jupyter lite build --XeusAddon.environment_file=some_path/to/environment.yaml

From prefix

Create a environment with the desired packages. Here is an example with numpy as a additional dependency

micromamba create
    -n myenv \
    --platform=emscripten-wasm32 \
    -c https://repo.mamba.pm/emscripten-forge \
    -c conda-forge \
    --yes \
    "python>=3.11"  numpy pandas xeus-python

Use the following command to build JupyterLite.

jupyter lite build --XeusAddon.prefix=$MAMBA_ROOT_PREFIX/envs/myenv