Back to Pixi

Jupyterlab

docs/integration/editor/jupyterlab.md

0.67.22.8 KB
Original Source

Basic usage

Using JupyterLab with Pixi is very simple. You can just create a new Pixi workspace and add the jupyterlab package to it. The full example is provided under the following Github link.

bash
pixi init
pixi add jupyterlab

This will create a new Pixi workspace and add the jupyterlab package to it. You can then start JupyterLab using the following command:

bash
pixi run jupyter lab

If you want to add more "kernels" to JupyterLab, you can simply add them to your current workspace – as well as any dependencies from the scientific stack you might need.

bash
pixi add bash_kernel ipywidgets matplotlib numpy pandas  # ...

What kernels are available?

You can easily install more "kernels" for JupyterLab. The conda-forge repository has a number of interesting additional kernels - not just Python!

Advanced usage

<!-- Modifications to the following section are related to the README.md in https://github.com/renan-r-santos/pixi-kernel and https://github.com/renan-r-santos/pixi-kernel-binder, please keep these two in sync by making a PR in both -->

If you want to have only one instance of JupyterLab running but still want per-directory Pixi environments, you can use one of the kernels provided by the pixi-kernel package.

Configuring JupyterLab

To get started, create a Pixi workspace, add jupyterlab and pixi-kernel and then start JupyterLab:

bash
pixi init
pixi add jupyterlab pixi-kernel
pixi run jupyter lab

This will start JupyterLab and open it in your browser.

pixi-kernel searches for a manifest file, either pixi.toml or pyproject.toml, in the same directory of your notebook or in any parent directory. When it finds one, it will use the environment specified in the manifest file to start the kernel and run your notebooks.