Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
doku:jupyterhub [2023/04/03 08:42] – katrindoku:jupyterhub [2024/09/19 16:52] (current) – katrin
Line 3: Line 3:
 The VSC offers a JupyterHub service available for all VSC users at [[https://jupyterhub.vsc.ac.at]] The VSC offers a JupyterHub service available for all VSC users at [[https://jupyterhub.vsc.ac.at]]
  
-Login works with any cluster user (both VSC3 and VSC4) and uses the OTP like on the cluster. A VPN connection is not needed.+Login works with any cluster user and uses the OTP like on the cluster. A VPN connection is not needed.
  
 Also make sure to checkout the [[doku:jupyterhub#FAQ|FAQ]] to see if your question was already answered. Also make sure to checkout the [[doku:jupyterhub#FAQ|FAQ]] to see if your question was already answered.
Line 26: Line 26:
   * VSC-4 python venv   * VSC-4 python venv
   * VSC-4 conda python env   * VSC-4 conda python env
-  * VSC-3 Singularity Image +  * VSC-5 Singularity Image 
-  * VSC-3 GTX1080 GPU Singularity Image +  * VSC-5 A40 GPU Singularity Image 
-  * VSC-3 A40 GPU Singularity Image+  * VSC-5 A100 GPU Singularity Image 
 +  * VSC-5 python venv 
 +  * VSC-5 conda python env 
 +  * VSC-5 A40 GPU conda python env 
 +  * VSC-5 A100 GPU Singularity Image
  
   * If you are participating in a training, there is most likely only a single fixed profile or special training profiles available   * If you are participating in a training, there is most likely only a single fixed profile or special training profiles available
  
-**Note:** You need a VSC4 user for the VSC4 profiles and a VSC3 user for the VSC3 profiles. You also need to have logged into the respective cluster via SSH at least once after getting a username.+**Note:** You need a VSC4 user for the VSC4 profiles and a VSC5 user for the VSC5 profiles. You also need to have logged into the respective cluster via SSH at least once after getting a username.
  
 In all profiles, you can choose the IDE, either Jupyter Notebook or the more modern Jupyter Lab (which is the default) In all profiles, you can choose the IDE, either Jupyter Notebook or the more modern Jupyter Lab (which is the default)
Line 85: Line 89:
  
 # This package provides functionality needed to run in the slurm environment of VSC (e.g. `batchspawner-singleuser` script). # This package provides functionality needed to run in the slurm environment of VSC (e.g. `batchspawner-singleuser` script).
-git+https://github.com/katringoogoo/batchspawner.git@1.2.0+auth_fix        +git+https://github.com/vsc-ac-at/batchspawner.git@1.2.0+auth_fix 
 + 
 +# June 2024: fix a dependency to an earlier version 
 +nbclassic==0.3.7
 </code> </code>
  
Line 91: Line 98:
   * jupyterlab-system-monitor   * jupyterlab-system-monitor
   * jupyterlab-git    * jupyterlab-git 
-  * jupyterlab-widgets+  * jupyterlab-widgets (or jupyterlab_widgets in conda)
  
-**An up 2 date list of packages can always be found in our repo: [[https://gitlab.tuwien.ac.at/vsc/jupyterhub/jupyterhub-docker-stacks/-/blob/main/tools/requirements.txt|requirements.txt]]**+**An up 2 date list of packages can always be found in our repo: [[https://gitlab.tuwien.ac.at/vsc-public/jupyterhub/jupyterhub-docker-stacks/-/blob/main/tools/requirements.txt|requirements.txt]]**
  
 === Run hooks from /usr/local/bin/before-notebook.d === === Run hooks from /usr/local/bin/before-notebook.d ===
Line 101: Line 108:
 Unfortunately the batchspawner package does not source them so we are using a custom startscript in our images called `vsc-singleuser.sh`. All it does is to run the hooks from `/usr/local/bin/before-notebook.d` before executing the `batchspawner-singleuser` script. Unfortunately the batchspawner package does not source them so we are using a custom startscript in our images called `vsc-singleuser.sh`. All it does is to run the hooks from `/usr/local/bin/before-notebook.d` before executing the `batchspawner-singleuser` script.
  
-The script can be found at [[https://gitlab.tuwien.ac.at/vsc/vsc-jupyterhub-notebooks/-/blob/main/tools/vsc-singleuser.sh|vsc-singleuser.sh]]. +The script can be found at [[https://gitlab.tuwien.ac.at/vsc-public/jupyterhub/jupyterhub-docker-stacks/-/blob/main/tools/vsc-singleuser.sh|vsc-singleuser.sh]]. 
  
 Note: Contact us to get read rights to the repository. Note: Contact us to get read rights to the repository.
Line 136: Line 143:
 BootStrap: docker BootStrap: docker
 From: jupyter/datascience-notebook:hub-3.1.1 From: jupyter/datascience-notebook:hub-3.1.1
 +
 %post %post
 /opt/conda/bin/pip install jupyterhub==3.1.1 git+https://github.com/katringoogoo/batchspawner.git@1.2.0+auth_fix                /opt/conda/bin/pip install jupyterhub==3.1.1 git+https://github.com/katringoogoo/batchspawner.git@1.2.0+auth_fix               
 </code> </code>
  
 +If we save the file as "my_image.def" we can use the build command to build the image with singularity/apptainer. 
  
 +Please not that you have to use apptainer if you want to build on the cluster, since the singularity version that comes installed on all nodes from the OS needs root rights to build an image.
 +
 +  * VSC4: module load --auto apptainer/1.1.9-gcc-12.2.0-vflkcfi
 +  * VSC5: module load --auto apptainer/1.1.6-gcc-12.2.0-xxfuqni
  
-If we save the file as "my_image.def" we can use the following commands to build the image with singularity 
  
 <code> <code>
-singularity build my_image.sif my_image.def+# load an apptainer module (see above) 
 +module load --auto apptainer/<version> 
 + 
 +# build the image 
 +apptainer build my_image.sif my_image.def
 </code> </code>
  
 +If you cannot use the versions provided on VSC you can of course also build the image on your own machine and upload it the VSC.
  
 ===== FAQ ===== ===== FAQ =====
  • doku/jupyterhub.1680511358.txt.gz
  • Last modified: 2023/04/03 08:42
  • by katrin