A JupyterLab extension to interface with the Slurm workload manager.
Slurm JupyterLab Extension
A JupyterLab extension that interfaces with the Slurm Workload Manager, providing simple and intuitive controls for viewing and managing jobs on the queue.
- JupyterLab >= 3.0
- Node.js 14+
This extension includes both a client-side JupyterLab extension and a server-side Jupyter notebook server extension. Install these using the command line with
pip install jupyterlab_slurm
If you are running Notebook 5.2 or earlier, enable the server extension by running
jupyter serverextension enable --py --sys-prefix jupyterlab_slurm
After launching JupyterLab, the extension can be found in the command palette under
Slurm Queue Manager, and is listed under the
HPC TOOLS section
of the palette and the launcher.
As described in the JupyterLab documentation for a development install of the labextension you can run the following in this directory:
Setup a local slurm cluster
git clone https://github.com/giovtorres/slurm-docker-cluster cd slurm-docker-cluster git clone --branch lab3 https://github.com/NERSC/jupyterlab-slurm.git cp jupyterlab-slurm/slurm_cluster/docker-compose.yml . # from slurm-docker-cluster README docker build -t slurm-docker-cluster:19.05.1 . # if you encounter an error with the PGP key step # update line 46 with gpg --keyserver pgp.mit.edu ... # this will build the jupyterlab image minimal-notebook with a slurm client docker-compose build # start the cluster docker-compose up -d # register the slurm cluster ./register_cluster.sh # run munged on the jupyterlab instance to get the slurm commands to connect docker-compose exec jupyterlab bash runuser -u slurm -- munged # test that squeue comes back with a header, if it gets stuck you can't connect squeue
Install jupyterlab-slurm into your environment
docker-compose exec -u jovyan jupyterlab bash cd /usr/local/jupyterlab-slurm/ # install jupyter_packaging which is a missing dependency pip install jupyter_packaging # this command takes a while the first it is run pip install -e . # point the labextension dev install at current dir jupyter labextension develop --overwrite . # rerun this if there are updates: jlpm run build
Restart the jupyterlab docker container
docker compose restart jupyterlab # rerun munged on the jupyterlab instance docker compose exec jupyterlab bash runuser -u slurm -- munged
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.