Difference between revisions of "Running Jupyter Notebook"

(One intermediate revision by the same user not shown)
Line 1: Line 1:
= On VDI =
Currently, the easiest way to run a Jupyter Notebook is on NCI's [[VDI|Virtual Desktop Infrastructure (VDI)]]. For a guide to set up and use VDI, click [https://opus.nci.org.au/display/Help/VDI+User+Guide here].
There are two options for running a Jupyter Notebook on the VDI. Either use the provided script to automate the process, or open a notebook in the strudel client window.
= On OOD =
== Scripted Access ==
Currently, the easiest way to run a Jupyter Notebook is on NCI's [[OOD|Open On-Demand service]]. For a guide to set up and use the OOD, click [https://opus.nci.org.au/display/OOD/Open+OnDemand+(OOD)+Service here].
=== Prerequisite ===
For this method to work in the easiest way, you should become part of the '''hh5''' project at NCI using [https://my.nci.org.au/mancini/project/hh5 my.nci.org.au].
This project will give you access to [[Conda|conda environments]] for Python managed by the CMS team.
When logging into the OOD, you will have an option to open Jupyter Lab. Please follow the instructions to request the best sized cluster for your work.
=== Method ===
Clone the [https://github.com/coecms/nci_scripts nci_scripts repository]&nbsp;and see the instructions to run the <code>vdi_jupyter.py</code> script. The script will prompt for an NCI username the first time it is used and after that it should work without prompting if ssh keys are properly set up (see Setting up SSH, but note the ssh key has to be copied to your home directory on VDI. Once you have a running session you can see which VDI node you are running on and copy the SSH key to it, or use the [https://opus.nci.org.au/display/Help/VDI+User+Guide#VDIUserGuide-3.5.2.SFTPTransferNode sftp transfer node]).
The script should open a Jupyter window in your default browser. It will show a listing of your VDI home directory. To access <tt>/g/data </tt>disks make symbolic links to the directories you need to access. e.g.
<pre>ln -s /g/data/v45 ~/gdata_v45
To run this command you will need shell access to the VDI. You&nbsp;can open a shell terminal window from within the jupyter notebook:
[[File:Jupyter terminal.png|How top open a terminal in a jupyter window]]
== Access via strudel ==
Within VDI, open a Linux terminal ('''Applications menu''' -> '''System Tools''' -> '''Terminal'''). Inside the Terminal, load the conda environment
<syntaxhighlight lang="bash">
module use /g/data/hh5/public/modules
module load conda
You should then be able to start the notebook with <syntaxhighlight lang="bash">
jupyter notebook
=== Connect your local browser ===
You can connect the browser on your computer to the jupyter notebook running on vdi once it's started.
You still need to connect to VDI in the usual way. Once the session is started, open a terminal. You need the name of the computer that is running your VDI instance. It is of the form '''vdi-nXX''' where XX is a number. It is possible that this is already displayed in your command line prompt there, otherwise you can run the command:
<syntaxhighlight lang="bash">
and it will give you the hostname. Remember it.
Next, you load the conda module as above, but tell jupyter to not start a browser:
<syntaxhighlight lang="bash">
module use /g/data/hh5/public/modules
module load conda
jupyter notebook --no-browser
You wait for this line:
<syntaxhighlight lang="unknown">
The 4 digits after the colon (often just 8888, but not always) are the port. We use this number and the hostname to create a new ssh connection to VDI. So in a new terminal session on your computer, run the command:
<syntaxhighlight lang="bash">
ssh userXX@vdi-nXX.nci.org.au -L 8888:localhost:8888
Of course, you need to replace '''userXX''' with your NCI username, '''vdi-nXX''' with the hostname, and ''both'' instances of '''8888''' with the actual port number.
Once you've done that, you can copy the full line that you got from jupyter notebook (the one
(including the full token) into your browser of choice.

Latest revision as of 03:09, 16 September 2021


Currently, the easiest way to run a Jupyter Notebook is on NCI's Open On-Demand service. For a guide to set up and use the OOD, click here.

When logging into the OOD, you will have an option to open Jupyter Lab. Please follow the instructions to request the best sized cluster for your work.


On Gadi

You can also run a notebook from Gadi's compute nodes using the gadi_jupyter script.


For this method to work, you must become part of the hh5 project at NCI using my.nci.org.au.

This project will give you access to conda environments for Python managed by the CMS team.

Setting Up SSH

You will need to set up SSH keys to use gadi_jupyter

Create the file ~/.ssh/config with something like the following lines in:

Host *.nci.org.au
User abc123 # Your NCI username here

Create a SSH key by running 'ssh-keygen'. It will ask for a 'passphrase', make sure you enter one, it doesn't need to be the same as your NCI password. Use the default key file name.

Copy your SSH key to gadi. Some computers have a command that can do this automatically - 'ssh-copy-id gadi.nci.org.au'. If not, you need to add the contents of the file '~/.ssh/id_rsa.pub' on your local computer to the end of the file '~/.ssh/authorized_keys' on Gadi.

Enable your SSH key by running the command 'ssh-add', it will ask for the SSH passphrase you entered when you made the key (which may not be your NCI password). If it says 'Could not open a connection to your SSH agent', or '‘could not connect to authentication agent', run 'ssh-agent bash' and then 'ssh-add'.

You can now run './gadi_jupyter'


  • You need to download this script to your own computer and execute there. The script handles the connection.
  • This job requires an implementation of bash. This is default on MacOS and Linux, but not Windows.
  • This will cost SU depending on the queue and the resources requested (default: 1 cores, express queue)
  • You also won't have access to the internet to, for example, download data.


You can download the script from the link above directly, or by running

git clone https://github.com/coecms/nci_scripts.git

which will download the script into a directory called nci_scripts.

There are several options that you can use when running the script:

General Options:
    -h:         Print help
    -l:         NCI username
    -L:         NCI login node (default 'gadi.nci.org.au')
    -e:         Conda environment

Queue Options:
    -q QUEUE:   Queue name
    -n NCPU:    Use NCPU cpus
    -m MEM:     Memory allocation (default 4*NCPU GB)
    -t TIME:    Walltime limit (default 1 hour)
    -J JOBFS:   Jobfs allocation (default 100 GB)
    -P PROJ:    Submit job under project PROJ

Windows Desktops

To run gadi_jupyter on Windows you'll need Bash and some form of SSH available. This could be from

* git bash - https://gitforwindows.org/
* cygwin terminal - https://www.cygwin.com/

Install one of these, then within the terminal follow the 'Setting up SSH' instructions before running 'gadi_jupyter'. (The terminal should start in your 'My Documents' directory if you need to find the downloaded script)