aitranspwood/jupyter-docker-extension repository overview

⁠AITW-JupyterLab Docker Extension

This is a Docker Extension aimed at facilitating the access of AI-TranspWood⁠ codebases made available in EESSI⁠. Each code base will present a notebook with an example on how to run a specific tool or workflow with a Graphical User Interface (GUI).

⁠Installation

⁠From Marketplace (not yet available)

Since Docker Desktop v4.11.0⁠ the AITW-JupyterLab Extension is available in the Marketplace page:

• From the Docker Desktop main window click on the Extensions tab in left side menu.
• If you have not installed any extension yet, you will automatically jump to the Manage>Browse page
• If you have already installed some extension, just click on the Manage tab and then on Browse button at top right side of the window
• Look for AI-TranspWood codebases in EESSI extension (it will have the AITW project logo on the left)
• Click on install

⁠From command line

From Docker Desktop, you can open a terminal by clicking on the ">_ Terminal" button at the bottom right corner of the window.

Then run the following command in the terminal to install the extension:

$ docker extension install aitranspwood/jupyter-docker-extension
Extensions can install binaries, invoke commands, access files on your machine and connect to remote URLs.
Are you sure you want to continue? [y/N] y
Extracting metadata and files for the extension "aitranspwood/jupyter-docker-extension:latest"
Installing service in Desktop VM...
Setting additional compose attributes
Installing Desktop extension UI for tab "AITW-JupyterLab"...
Extension UI tab "AITW-JupyterLab" added.
Starting service in Desktop VM......
Service in Desktop VM started
Extension "AI-TranspWood codebases in EESSI" installed successfully

Note: Docker Extension CLI is required to execute above command, that is normally included in Docker Desktop installation. If it does not work,follow the instructions at Extension SDK (Beta) -> Prerequisites⁠ page for instructions on how to add it. For more information, see the Docker documentation⁠.

⁠Notes

• The CVMFS cache is configured to use up to 10GB of disk space on your machine, this is not yet configurable so make sure you have enough disk space available (on average you will need ~3GB, when loading all examples).

⁠Usage

Once the extension is installed a new extension is listed in the Extension pane of Docker Desktop. Click on the project icon, the JupyterLab welcome page will appear. From there you check out the available demo notebooks under the "AITW" list.

⁠Persistent storage

Any data stored in the /home/eessi-user directory in the container will be persisted against Docker Desktop restarts or Extension updates. The data from the CVMFS cache is also persisted to make running EESSI software quicker after restarts.

⁠Uninstall

⁠From Docker Desktop

• Navigate to the same Extensions > Manage page where you installed the extension.
• Click the three dots menu on the extension card and select Uninstall.

⁠From Command Line

$ docker extension uninstall aitranspwood/jupyter-docker-extension
Extension "Jupyter Notebook" uninstalled successfully

⁠Sources

List of repositories hosting the source code used in this extension:

• Docker Extension: https://github.com/AI-TranspWood/jupyter-docker-extension⁠
• EESSI-enabled JupyterLab container with preloaded AITW notebooks: https://github.com/AI-TranspWood/EESSI-jupyterlab-docker⁠
• AITW notebooks: https://github.com/AI-TranspWood/jupyter-notebooks⁠