[Minor] Rename the CSCS Todi cluster to CSCS Clariden (#28)

skandermoalla · web-flow · commit de57f79b05a8 · 2025-01-13T21:35:50.000+01:00
diff --git a/README.md b/README.md
@@ -61,7 +61,7 @@ Remember to get back to this root one after finishing each step.
 1. Clone the repo with destination `PROJECT_NAME`.
     - If you plan to develop on your local computer, clone it there.
     - If you plan to develop on your remote server (with direct access over say SSH, e.g. EPFL HaaS), clone it there.
-    - If you plan to develop on CSCS Todi, clone it there (use an allocation with a compute node, not the login node)
+    - If you plan to develop on CSCS Clariden, clone it there (use an allocation with a compute node, not the login node)
     - If you plan to develop or deploy on a managed cluster without a build engine
       (e.g., EPFL Run:ai clusters, SCITAS clusters), clone on your local machine.
       (Docker allows cross-platform builds with emulation, but it can be slow.
diff --git a/installation/docker-amd64-cuda/.dockerignore b/installation/docker-amd64-cuda/.dockerignore
@@ -1,4 +1,4 @@
-CSCS-Todi-setup
+CSCS-Clariden-setup
 EPFL-runai-setup
 EPFL-SCITAS-setup
 from-python-template
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/.gitignore b/installation/docker-amd64-cuda/CSCS-Clariden-setup/.gitignore
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/README.md b/installation/docker-amd64-cuda/CSCS-Clariden-setup/README.md
@@ -1,9 +1,9 @@
-# Guide for using the template with the CSCS Todi cluster
+# Guide for using the template with the CSCS Clariden cluster
 
 ## Overview
 
 At this point, you should have edited the environment files and are ready to build or run the image.
-This guide will show you how to build and run your image on the CSCS Todi cluster and use it for
+This guide will show you how to build and run your image on the CSCS Clariden cluster and use it for
 
 1. Remote development.
 2. Running unattended jobs.
@@ -44,8 +44,14 @@ pip install podman-compose
 All commands should be run from the `installation/docker-amd64-cuda/` directory.
 
 You should be on a compute node. If not already, get one.
-```
-srun --partition=debug --time=0:30:00 --pty bash
+```bash
+# Request a compute node
+sbatch -N  --time 4:00:00 -A a-a10 --wrap "sleep infinity" --output=/dev/null --error=/dev/null
+# Connect to it
+srun --overlap --pty --jobid=GET_THE_JOB_ID bash
+tmux
+# or if reconnecting
+tmux at
 ```
 
 ```bash
@@ -95,7 +101,7 @@ cd installation/docker-amd64-cuda
 
 **CSCS and Slurm**:
 
-1. You should have access to the Todi cluster.
+1. You should have access to the Clariden cluster.
 2. You should have some knowledge of Slurm.
 
 There is a great documentation provided by the SwissAI initiative [here](https://github.com/swiss-ai/documentation).
@@ -129,7 +135,7 @@ This guide includes the steps to do it, and there are general details in `data/R
 
 ```bash
 # SSH to a cluster.
-ssh todi
+ssh clariden
 cd $SCRATCH
 # Clone the repo twice with name dev and run (if you already have one, mv it to a different name)
 mkdir template-project-name
@@ -163,12 +169,12 @@ They will be in `./EPFL-SCITAS-setup/submit-scripts`.
 
 Adapt the `submit-scripts/minimal.sh` with the name of your image and your cluster storage setup.
 
-The submission script gives an example of how to run containers on Todi with [`enroot`](https://github.com/NVIDIA/enroo)
+The submission script gives an example of how to run containers on Clariden with [`enroot`](https://github.com/NVIDIA/enroo)
 and the [`pyxis`](https://github.com/NVIDIA/pyxis) plugin directly integrated in `srun`,
 
 Run the script to see how the template works.
 ```bash
-cd installation/docker-amd64-cuda//CSCS-Todi-setup/submit-scripts
+cd installation/docker-amd64-cuda//CSCS-Clariden-setup/submit-scripts
 bash minimal.sh
 ```
 
@@ -256,24 +262,24 @@ GitHub provides a guide for that
 Use the following configuration in your local `~/.ssh/config`
 
 ```bash
-Host todi
-    HostName todi.cscs.ch
+Host clariden
+    HostName clariden.cscs.ch
     User smoalla
     ProxyJump ela
     ForwardAgent yes
 
 # EDIT THIS HOSTNAME WITH EVERY NEW JOB
-Host todi-job
+Host clariden-job
     HostName nid005105
     User smoalla
-    ProxyJump todi
+    ProxyJump clariden
     StrictHostKeyChecking no
 	  UserKnownHostsFile=/dev/null
 	  ForwardAgent yes
 
-Host todi-container
+Host clariden-container
     HostName localhost
-    ProxyJump todi-job
+    ProxyJump clariden-job
     Port 2223
     User smoalla
 	  StrictHostKeyChecking no
@@ -286,7 +292,7 @@ of the host [(ref)](https://linuxcommando.blogspot.com/2008/10/how-to-disable-ss
 which keeps changing every time a job is scheduled,
 so that you don't have to reset it each time.
 
-With this config you can then connect to your container with `ssh todi-container`.
+With this config you can then connect to your container with `ssh clariden-container`.
 
 **Limitations**
 
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/README.md b/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/README.md
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/edf.toml b/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/edf.toml
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/minimal.sh b/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/minimal.sh
@@ -14,7 +14,7 @@ srun \
   -J template-minimal \
   --pty \
   --container-image=$CONTAINER_IMAGES/claire+smoalla+template-project-name+amd64-cuda-root-latest.sqsh \
-  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Todi-setup/submit-scripts/edf.toml" \
+  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Clariden-setup/submit-scripts/edf.toml" \
   --container-mounts=$SCRATCH \
   --container-workdir=$PROJECT_ROOT_AT \
   --no-container-mount-home \
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/remote-development.sh b/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/remote-development.sh
@@ -17,7 +17,7 @@ export JETBRAINS_SERVER_AT=$SCRATCH/jetbrains-server
 
 srun \
   --container-image=$CONTAINER_IMAGES/claire+smoalla+template-project-name+amd64-cuda-root-latest.sqsh \
-  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Todi-setup/submit-scripts/edf.toml" \
+  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Clariden-setup/submit-scripts/edf.toml" \
   --container-mounts=\
 $SCRATCH,\
 $WANDB_API_KEY_FILE_AT,\
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/test-interactive.sh b/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/test-interactive.sh
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/unattended-distributed.sh b/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/unattended-distributed.sh
@@ -18,7 +18,7 @@ export WANDB_API_KEY_FILE_AT=$HOME/.wandb-api-key
 
 srun \
   --container-image=$CONTAINER_IMAGES/claire+smoalla+template-project-name+amd64-cuda-root-latest.sqsh \
-  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Todi-setup/submit-scripts/edf.toml" \
+  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Clariden-setup/submit-scripts/edf.toml" \
   --container-mounts=\
 $SCRATCH,\
 $WANDB_API_KEY_FILE_AT \
diff --git a/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/unattended.sh b/installation/docker-amd64-cuda/CSCS-Clariden-setup/template-submit-examples/unattended.sh
@@ -10,7 +10,7 @@ export SLURM_ONE_ENTRYPOINT_SCRIPT_PER_NODE=1
 
 srun \
   --container-image=$CONTAINER_IMAGES/claire+smoalla+template-project-name+amd64-cuda-root-latest.sqsh \
-  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Todi-setup/submit-scripts/edf.toml" \
+  --environment="${PROJECT_ROOT_AT}/installation/docker-amd64-cuda/CSCS-Clariden-setup/submit-scripts/edf.toml" \
   --container-mounts=$SCRATCH \
   --container-workdir=$PROJECT_ROOT_AT \
   --no-container-mount-home \
diff --git a/installation/docker-amd64-cuda/README.md b/installation/docker-amd64-cuda/README.md
@@ -23,7 +23,7 @@ for your future users (and yourself).
    The default platform is Linux (fixed) on AMD64 CPUs `amd64` (can be changed to e.g. `arm64`)
    with support for NVIDIA GPUs.
    (reflected in the name of the directory `docker-amd64-cuda` by default).
-   (The EPFL Run:ai and the SCITAS clusters are on `amd64`, the CSCS Todi cluster is on `arm64`.)
+   (The EPFL Run:ai and the SCITAS clusters are on `amd64`, the CSCS Clariden cluster is on `arm64`.)
    If this is good for you, you can skip this part.
    Otherwise, to edit it, run
    ```bash
@@ -93,7 +93,7 @@ for your future users (and yourself).
    If you change the dependency files commit so that you can track what worked and what didn't.
 6. Build the environment following the instructions to [build the environment](#obtainingbuilding-the-environment).
    (Obviously, you'll have to build the generic image not pull it.)
-   For CSCS todi, steps 6, 7, and 8 are described in `./CSCS-Todi-setup/README.md`.
+   For CSCS clariden, steps 6, 7, and 8 are described in `./CSCS-Clariden-setup/README.md`.
    Follow the instructions there.
 7. Follow the instructions to [run the environment](#the-environment) with your target
    deployment option.
@@ -218,9 +218,9 @@ We provide the following guides for obtaining/building and running the environme
   The guide also provides instructions to do remote development on the SCITAS cluster
   with VSCode, PyCharm, and Jupyter Lab.
   Other Slurm + enroot/Apptainer/Singularity cluster users can get inspiration from it too.
-- To run on the CSCS Todi cluster, follow the instructions in `./CSCS-Todi-setup/README.md`.
+- To run on the CSCS Clariden cluster, follow the instructions in `./CSCS-Clariden-setup/README.md`.
 
-  The guide also provides instructions to do remote development on the Todi cluster
+  The guide also provides instructions to do remote development on the Clariden cluster
   with VSCode, PyCharm, and Jupyter Lab.
   Other Slurm + enroot cluster users can get inspiration from it too.
 
diff --git a/installation/docker-amd64-cuda/template.sh b/installation/docker-amd64-cuda/template.sh
@@ -8,7 +8,7 @@ ENV_TEXT=$(
 
 ## For building:
 # Which docker and compose binary to use
-# docker and docker compose in general or podman and podman-compose for CSCS todi
+# docker and docker compose in general or podman and podman-compose for CSCS Clariden
 DOCKER=docker
 COMPOSE="docker compose"
 # Use the same USRID and GRPID as on the storage you will be mounting.
@@ -329,8 +329,8 @@ get_cscs_scripts() {
   # Rename the scitas examples.
   # ./template.sh get_scitas_scripts
   check
-  cp -r "./CSCS-Todi-setup/template-submit-examples/" "./CSCS-Todi-setup/submit-scripts"
-  for file in $(find "./CSCS-Todi-setup/submit-scripts" -type f); do
+  cp -r "./CSCS-Clariden-setup/template-submit-examples/" "./CSCS-Clariden-setup/submit-scripts"
+  for file in $(find "./CSCS-Clariden-setup/submit-scripts" -type f); do
     sed -i.deleteme "s/smoalla/${USR}/g" "$file" && rm "${file}.deleteme"
     sed -i.deleteme "s/claire/${LAB_NAME}/g" "$file" && rm "${file}.deleteme"
   done

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-CSCS-Todi-setup`
	`1`	`+CSCS-Clariden-setup`
`2`	`2`	`EPFL-runai-setup`
`3`	`3`	`EPFL-SCITAS-setup`
`4`	`4`	`from-python-template`