/aiidalab-toolbox

This is a JupyterLab extension, which creates a siderbar as a toolbox for AiiDA lab.

Primary LanguageCSSBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

aiidalab-toolbox

Github Actions Status

This is a JupyterLab sidbar for AiiDA lab. There is a collection of the AiiDA lab base widgets in the sidebar.

Requirements

  • JupyterLab >= 2.0

Pre installation

pip install aiidalab-widgets-base

Install

jupyter labextension install aiidalab-toolbox

Contributing

Install

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
# Move to aiidalab-toolbox directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

Uninstall

jupyter labextension uninstall aiidalab-toolbox