Reana JupyterLab Extension

Reana JupyterLab plugin provides a set of tools to interact with the Reana workflow management system from within JupyterLab.

Requirements

• JupyterLab>=4,<5
• Notebook<7
• Node.js==20
• Custom version of reana-client

Installation guide for users

To install the extension, run the following command:

pip install reana-jupyterlab

In case you want to run the tests, install the extension with the following command:

pip install reana-jupyterlab[dev]

Docker image

It is possible to run the extension in a Docker container. To download and run the image, use the following commands:

docker pull ghcr.io/vre-hub/reana-jupyterlab-extension:<version>
docker run -p 8888:8888 ghcr.io/vre-hub/reana-jupyterlab-extension

All the available versions can be found here.

Installation guide for developers

Install Python dependencies

python -m pip install -r requirements.txt

Install Yarn dependencies

jlpm install

Build the extension

jlpm run build

Install the extension (including the testing dependencies)

python -m pip install .[dev]

Enable the server extension

jupyter server extension enable --py reana_jupyterlab

Finally, open a JupyterLab instance. The extension should be available in the JupyterLab sidebar.

jupyter lab