Using Conda Environments
Using Widgets
Requesting a GPU
Do Not Run Jupyter on the Login Nodes
Base Conda Environment
Custom Conda Environment
Another Approach
Running as a batch job
An example pbs script (pbs.jupyter) is as follows:
#!/bin/bash
#PBS -N jupyterN
#PBS -m abe
#PBS -M myemail@griffithuni.edu.au
##PBS -q workq
#PBS -q gpuq2
#PBS -l select=1:ncpus=1:ngpus=1:mem=12gb,walltime=0:13:00
# get tunneling info
XDG_RUNTIME_DIR=""
node=$(hostname -s)
user=$(whoami)
cluster="gc-prd-hpclogin1"
##Please change below port as it may be in use
##choose your own unique port between 8000 and 9999
port=8895
cd $PBS_O_WORKDIR
# print tunneling instructions tunnel.$PBS_JOBID.txt
JJID=`echo $PBS_JOBID|sed 's/\.gc-prd-hpcadm//g'`
echo -e "
Command to create ssh tunnel:
ssh -N -f -L ${port}:${node}:${port} ${user}@${cluster}.rcs.griffith.edu.au
Use a Browser on your local machine to go to:
localhost:${port} (prefix w/ https:// if using password)" >tunnel.$JJID.txt
# load modules or conda environments here
module load anaconda3/2021.11
source activate myenv
# Run Jupyter
jupyter-notebook --no-browser --port=${port} --ip=${node} 2>&1 | tee jupnote.$JJID.log
qsub pbs.jupyter
#It gives a jobID (e.g 218157). If you do a listing of the file in the PBS_O_WORKDIR when the job runs, you will see two files:
tunnel.JOBID.txt (e.g tunnel.218157.txt) and jupnote.JOBID.log (e.g jupnote.218157.log)
You can look into the content of both files to get the syntax for tunnelling (in the tunnel file) and the actual web addess (in jupnote file)
cat tunnel.JOBID.txt
you will see something like this:
ssh -N -f -L 8889:n061:8889 s123456@gc-prd-hpclogin1.rcs.griffith.edu.au
cat jupnote.JOBID.log
You will see something like this:
http://127.0.0.1:8895/?token=9d109cd760cd214d689825d87db60302103712acb4560921
Lastly, open a web browser on your laptop/desktop and copy and paste the URL from the previous output:
Note: If needed only: you may run the following command on your local machine to start port forwarding.
For n060 gpu node
ssh -CNL 8889:localhost:8889 s123456@n060.rcs.griffith.edu.au
For gpu node n061:
ssh -N -f -L 8889:n061:8889 -J s123456@gc-prd-hpclogin1.rcs.griffith.edu.au s123456@n061
Note that we selected the Linux port 8889 in the above command to connect to the notebook. If you don't specify the port, it will default to port 8888 but sometimes this port can be already in use either on the remote machine or the local one
(i.e., your laptop). If the port you selected is unavailable, you will get an error message, in which case you should just pick another one. It is best to keep it greater than 1024.
Consider starting with 8888 and increment by 1 if it fails, e.g., try 8888, 8889, 8890 and so on. If you are running on a different port then substitute your port number for 8889.