Skip to main content

Lmod JupyterLab extension

Project description

Jupyter Lmod

Jupyter interactive notebook server extension that allows user to interact with environment modules before launching kernels. The extension use Lmod's Python interface to accomplish module related task like loading, unloading, saving collection, etc.


If jupyter-server-proxy and jupyterlab-server-proxy are detected, jupyter-lmod will add the proxy server launchers to JupyterLab UI when modules with matching names are loaded.



pip install jupyterlmod

Disable jupyter-server-proxy notebook and lab extensions

To avoid having items in the launcher that cannot be launched because the binaries location are not in PATH, jupyter-lmod hides launcher items that do not have a corresponding loaded module. jupyter-server-proxy notebook and lab extension always display the launcher item. To avoid a situation where an item would be shown twice, we recommend disabling jupyter-server-proxy notebook and lab extensions.

This can be done with the following command for notebook:

jupyter nbextension disable --py jupyter_server_proxy --sys-prefix

and with the following commands for jupyterlab:

jupyter labextension disable @jupyterlab/server-proxy
jupyter labextension disable jupyterlab-server-proxy

Pinning launcher items

If server proxies do not have a corresponding modules, or you wish to have their launcher items displayed regardless of the loaded modules, you can define a list of items that will be pinned in the Jupyter notebook configuration file, like this:

c.Lmod.launcher_pins = ['Desktop', 'RStudio']


Jupyter notebook demo

JupyterLab demo



  • pip >= 23
  • build
  • nodejs >= 18.x


  • wheel and tarball:
  • labextension
    cd jupyterlab
    npm install
    npm run build
    # To install extension in jupyterlab in develop mode:
    npm run install:extension

Project details

Download files

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

Source Distribution

jupyterlmod-4.0.3.tar.gz (28.6 MB view hashes)

Uploaded source

Built Distribution

jupyterlmod-4.0.3-py3-none-any.whl (59.4 kB view hashes)

Uploaded py3

Supported by

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