JupyterLab Kernel Usage
Advance notice: this extension is being contributed upstream; future versions will be published under jupyter-server/jupyter-resource-usage.
This is an extension for JupyterLab to get kernel usage in a sidebar.
This extension is composed of a Python package named
jupyterlab_kernel_usage for the server extension and a NPM package named
jupyterlab-kernel-usage for the frontend extension.
This usage is only show for IPython kernels with ipykernel >= 6.11.0.
Use the provided
environment.yaml to install the conda environment.
conda deactivate && \ make env-rm && \ make env conda activate jupyterlab-kernel-usage
# Install the server and frontend in dev mode. make install-dev
# In terminal 1, Start the jupyterlab. # open http://localhost:8234?token=... make jlab
# In terminal 2, start the extension building in watch mode. make watch
When making changes to the extension you will need to issue a
jupyter labextension build, or, start
jlpm run watch in the root of the repository to rebuild on every changes. You do not need to restart or rebuild JupyterLab for changes on the frontend extensions, but do need to restart the server for changes to the Python code.
Note: You will need NodeJS to build the extension package.
jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
npm in lieu of
# Clone the repo to your local environment # Change directory to the jupyterlab_kernel_usage directory # Install package in development mode pip install -e . # Link your development version of the extension with JupyterLab jupyter labextension develop . --overwrite # Server extension must be manually installed in develop mode jupyter server extension enable jupyterlab_kernel_usage # Rebuild extension Typescript source after making changes jlpm run build
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed jlpm run watch # Run JupyterLab in another terminal jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the
jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
# Server extension must be manually disabled in develop mode jupyter server extension disable jupyterlab_kernel_usage pip uninstall jupyterlab_kernel_usage
In development mode, you will also need to remove the symlink created by
jupyter labextension develop
command. To find its location, you can run
jupyter labextension list to figure out where the
folder is located. Then you can remove the symlink named
jupyterlab_kernel_usage within that folder.
- JupyterLab >= 3.0
To install the extension, execute:
pip install jupyterlab_kernel_usage
To remove the extension, execute:
pip uninstall jupyterlab_kernel_usage
If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:
jupyter server extension list
If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:
jupyter labextension list
Packaging the extension