rsjupyterlab

Jupyterlab extension repository for sirepo/jupyter

Requirements

• JupyterLab >= 3.0

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the rsjupyterlab directory
# Install package in development mode. Needed for develop command below
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop rsjupyterlab --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

Running Jupyterlab

• Option A: After linking and building your extension, to run jupyterlab:

jupyter lab --ip='*'

In your terminal you'll see:

Jupyter Server 1.17.0 is running at:
  http://localhost:<port no.>/lab?token=<token>

Copy that token and navigate to v.radia.run:<port no.>/lab?token=<token>

• Option B: running sirepo/jupyter Run a sirepo jupyter server from sirepo repo directory

cd ~/src/radiasoft/sirepo

bash etc/run.sh jupyterhub

This option lets you access jupyterlab through sirepo and gives access to authstate etc.

Troubleshooting and more

You may need to disable an extension

jupyter labextension disable <extension_name>

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

Uninstall

pip uninstall rsjupyterlab