Quick Start Guide

galyleo is a command-line shell utility to help you launch Jupyter notebook sessions on high-performance computing (HPC) systems in a simple, secure way.

galyleo works in conjunction with the Satellite Reverse Proxy Service and the Slurm Workload Manager to provide each Jupyter notebook server you start with its own one-time, token-authenticated HTTPS connection between the compute resources of the HPC system the notebook server is running on and your web browser. This secure connection affords both privacy and integrity to the data exchanged between the notebook server and your browser, helping protect you and your work against network eavesdropping and data tampering.

galyleo is currently deployed on the following systems at the San Diego Supercomputer Center:

• Expanse
• Triton Shared Compute Cluster (TSCC)

To use galyleo, you first need to prepend its install location to your PATH environment variable. This path is different for each system.

On Expanse, use:

export PATH="/cm/shared/apps/sdsc/galyleo:${PATH}"

On TSCC, there is now a software module available to load galyleo into your environment.

module load galyleo/0.7.4 

Once galyleo is in your PATH, you can use its launch command to create a secure Jupyter notebook session. A number of command-line options will allow you to configure:

• the compute resources required to run your Jupyter notebook session;
• the type of Jupyter interface you want to use for the session and the location of the notebook working directory; and
• the software environment that contains the jupyter notebook server and the other software packages you want to work with during the session.

For example, you can use the launch command to request a 30-minute JupyterLab session with two CPU cores and four GB of memory on one of Expanse's AMD compute nodes in the debug partition using the version of JupyterLab available in its cpu/0.17.3b software module environment.

galyleo launch --account abc123 --partition debug --cpus 2 --memory 4 --time-limit 00:30:00 --env-modules cpu/0.17.3b,gcc/10.2.0,py-jupyterlab/3.2.1 --quiet

When the launch command returns successfully, you will be issued a unique HTTPS URL for your secure Jupyter notebook session.

https://wages-astonish-recapture.expanse-user-content.sdsc.edu?token=1abe04ac1703ca623e4e907cc37678ae

Copy and paste this URL into your web browser. Your Jupyter notebook session will begin once the requested compute resources are available and allocated by the Slurm scheduler.