SLURM -> Slurm (#173)

With #148 it is suggested to rename SLURM -> Slurm. This is an accompanying PR to change it also on every other page for consistency.

Author: finkandreas

docs/clusters/bristen.md

@@ -44,9 +44,9 @@ Users are encouraged to use containers on Bristen.
 
 ## Running Jobs on Bristen
 
-### SLURM
+### Slurm
 
-Bristen uses [SLURM][ref-slurm] as the workload manager, which is used to launch and monitor distributed workloads, such as training runs.
+Bristen uses [Slurm][ref-slurm] as the workload manager, which is used to launch and monitor distributed workloads, such as training runs.
 
 There is currently a single slurm partition on the system:
 
@@ -58,7 +58,7 @@ There is currently a single slurm partition on the system:
 | `normal` | 32       | -    | 24 hours |
 
 <!--
-See the SLURM documentation for instructions on how to run jobs on the [Grace-Hopper nodes][ref-slurm-gh200].
+See the Slurm documentation for instructions on how to run jobs on the [Grace-Hopper nodes][ref-slurm-gh200].
 
 ??? example "how to check the number of nodes on the system"
     You can check the size of the system by running the following command in the terminal:
@@ -78,7 +78,7 @@ Bristen can also be accessed using [FirecREST][ref-firecrest] at the `https://ap
 
 ### Scheduled Maintenance
 
-Wednesday morning 8-12 CET is reserved for periodic updates, with services potentially unavailable during this timeframe. If the queues must be drained (redeployment of node images, rebooting of compute nodes, etc) then a Slurm reservation will be in place that will prevent jobs from running into the maintenance window. 
+Wednesday morning 8-12 CET is reserved for periodic updates, with services potentially unavailable during this timeframe. If the queues must be drained (redeployment of node images, rebooting of compute nodes, etc) then a Slurm reservation will be in place that will prevent jobs from running into the maintenance window.
 
 Exceptional and non-disruptive updates may happen outside this time frame and will be announced to the users mailing list, and on the [CSCS status page](https://status.cscs.ch).
 
@@ -87,4 +87,4 @@ Exceptional and non-disruptive updates may happen outside this time frame and wi
 !!! change "2025-03-05 container engine updated"
     now supports better containers that go faster. Users do not to change their workflow to take advantage of these updates.
 
-### Known issues
+### Known issues

docs/clusters/clariden.md

@@ -67,9 +67,9 @@ Alternatively, [uenv][ref-uenv] are also available on Clariden. Currently deploy
 
 ## Running Jobs on Clariden
 
-### SLURM
+### Slurm
 
-Clariden uses [SLURM][ref-slurm] as the workload manager, which is used to launch and monitor distributed workloads, such as training runs.
+Clariden uses [Slurm][ref-slurm] as the workload manager, which is used to launch and monitor distributed workloads, such as training runs.
 
 There are two slurm partitions on the system:
 
@@ -87,7 +87,7 @@ There are two slurm partitions on the system:
 * nodes in the `xfer` partition can be shared
 * nodes in the `debug` queue have a 1.5 node-hour time limit. This means you could for example request 2 nodes for 45 minutes each, or 1 single node for the full time limit.
 
-See the SLURM documentation for instructions on how to run jobs on the [Grace-Hopper nodes][ref-slurm-gh200].
+See the Slurm documentation for instructions on how to run jobs on the [Grace-Hopper nodes][ref-slurm-gh200].
 
 ??? example "how to check the number of nodes on the system"
     You can check the size of the system by running the following command in the terminal:

docs/clusters/santis.md

@@ -72,11 +72,11 @@ It is also possible to use HPC containers on Santis:
 
 ## Running jobs on Santis
 
-### SLURM
+### Slurm
 
-Santis uses [SLURM][ref-slurm] as the workload manager, which is used to launch and monitor distributed workloads, such as training runs.
+Santis uses [Slurm][ref-slurm] as the workload manager, which is used to launch and monitor distributed workloads, such as training runs.
 
-There are two [SLURM partitions][ref-slurm-partitions] on the system:
+There are two [Slurm partitions][ref-slurm-partitions] on the system:
 
 * the `normal` partition is for all production workloads.
 * the `debug` partition can be used to access a small allocation for up to 30 minutes for debugging and testing purposes.
@@ -91,7 +91,7 @@ There are two [SLURM partitions][ref-slurm-partitions] on the system:
 * nodes in the `normal` and `debug` partitions are not shared
 * nodes in the `xfer` partition can be shared
 
-See the SLURM documentation for instructions on how to run jobs on the [Grace-Hopper nodes][ref-slurm-gh200].
+See the Slurm documentation for instructions on how to run jobs on the [Grace-Hopper nodes][ref-slurm-gh200].
 
 ### FirecREST
 

docs/contributing/index.md

@@ -244,7 +244,7 @@ For adding information about a change, originally designed for recording updates
 
 === "Rendered"
     !!! change "2025-04-17"
-        * SLURM was upgraded to version 25.1.
+        * Slurm was upgraded to version 25.1.
         * uenv was upgraded to v0.8
 
     Old changes can be folded:
@@ -256,7 +256,7 @@ For adding information about a change, originally designed for recording updates
 === "Markdown"
     ```
     !!! change "2025-04-17"
-        * SLURM was upgraded to version 25.1.
+        * Slurm was upgraded to version 25.1.
         * uenv was upgraded to v0.8
     ```
 

docs/guides/mlp_tutorials/llm-finetuning.md

@@ -78,20 +78,20 @@ accelerate launch --config_file trl/examples/accelerate_configs/multi_gpu.yaml \
 
 This script has quite a bit more content to unpack.
 We use HuggingFace accelerate to launch the fine-tuning process, so we need to make sure that accelerate understands which hardware is available and where.
-Setting this up will be useful in the long run because it means we can tell SLURM how much hardware to reserve, and this script will setup all the details for us.
+Setting this up will be useful in the long run because it means we can tell Slurm how much hardware to reserve, and this script will setup all the details for us.
 
 The cluster has four GH200 chips per compute node.
 We can make them accessible to scripts run through srun/sbatch via the option `--gpus-per-node=4`.
 Then, we calculate how many processes accelerate should launch.
 We want to map each GPU to a separate process, this should be four processes per node.
 We multiply this by the number of nodes to obtain the total number of processes.
-Next, we use some bash magic to extract the name of the head node from SLURM environment variables.
+Next, we use some bash magic to extract the name of the head node from Slurm environment variables.
 Accelerate expects one main node and launches tasks on the other nodes from this main node.
 Having sourced our python environment at the top of the script, we can then launch Gemma fine-tuning.
 The first four lines of the launch line are used to configure accelerate.
 Everything after that configures the `trl/examples/scripts/sft.py` Python script, which we use to train Gemma.
 
-Next, we also need to create a short SLURM batch script to launch our fine-tuning script:
+Next, we also need to create a short Slurm batch script to launch our fine-tuning script:
 
 ```bash title="fine-tune-sft.sbatch"
 #!/bin/bash

docs/guides/mlp_tutorials/llm-inference.md

@@ -62,9 +62,9 @@ This step is straightforward, just make the file `$HOME/.config/containers/stora
   mount_program = "/usr/bin/fuse-overlayfs-1.13"
 ```
 
-To build a container with Podman, we need to request a shell on a compute node from [SLURM][ref-slurm], pass the Dockerfile to Podman, and finally import the freshly built container using enroot.
-SLURM is a workload manager which distributes workloads on the cluster.
-Through SLURM, many people can use the supercomputer at the same time without interfering with one another in any way:
+To build a container with Podman, we need to request a shell on a compute node from [Slurm][ref-slurm], pass the Dockerfile to Podman, and finally import the freshly built container using enroot.
+Slurm is a workload manager which distributes workloads on the cluster.
+Through Slurm, many people can use the supercomputer at the same time without interfering with one another in any way:
 
 ```console
 $ srun -A <ACCOUNT> --pty bash
@@ -75,7 +75,7 @@ $ enroot import -x mount -o pytorch-24.01-py3-venv.sqsh podman://pytorch:24.01-p
 ```
 
 where you should replace `<ACCOUNT>` with your project account ID.
-At this point, you can exit the SLURM allocation by typing `exit`.
+At this point, you can exit the Slurm allocation by typing `exit`.
 You should be able to see a new squashfile next to your Dockerfile:
 
 ```console
@@ -161,8 +161,8 @@ $ pip install -U "huggingface_hub[cli]"
 $ HF_HOME=$SCRATCH/huggingface huggingface-cli login
 ```
 
-At this point, you can exit the SLURM allocation again by typing `exit`.
-If you `ls` the contents of the `gemma-inference` folder, you will see that the `gemma-venv` virtual environment folder persists outside of the SLURM job.
+At this point, you can exit the Slurm allocation again by typing `exit`.
+If you `ls` the contents of the `gemma-inference` folder, you will see that the `gemma-venv` virtual environment folder persists outside of the Slurm job.
 Keep in mind that this virtual environment won't actually work unless you're running something from inside the PyTorch container.
 This is because the virtual environment ultimately relies on the resources packaged inside the container.
 
@@ -196,8 +196,8 @@ There's nothing wrong with this approach per se, but consider that you might be
 You'll want to document how you're calling Slurm, what commands you're running on the shell, and you might not want to (or might not be able to) keep a terminal open for the length of time the job might take.
 For this reason, it often makes sense to write a batch file, which enables you to document all these processes and run the Slurm job regardless of whether you're still connected to the cluster.
 
-Create a SLURM batch file `gemma-inference.sbatch` anywhere you like, for example in your home directory.
-The SLURM batch file should look like this:
+Create a Slurm batch file `gemma-inference.sbatch` anywhere you like, for example in your home directory.
+The Slurm batch file should look like this:
 
 ```bash title="gemma-inference.sbatch"
 #!/bin/bash
@@ -220,14 +220,14 @@ set -x
 python ./gemma-inference.py
 ```
 
-The first few lines of the batch script declare the shell we want to use to run this batch file and pass several options to the SLURM scheduler.
+The first few lines of the batch script declare the shell we want to use to run this batch file and pass several options to the Slurm scheduler.
 You can see that one of these options is one we used previously to load our EDF file.
 After this, we `cd` to our working directory, `source` our virtual environment and finally run our inference script.
 
 As an alternative to using the `#SBATCH --environment=gemma-pytorch` option you can also run the code in the above script wrapped into an `srun -A <ACCOUNT> -ul --environment=gemma-pytorch bash -c "..."` statement.
 The tutorial on nanotron e.g. uses this pattern in `run_tiny_llama.sh`.
 
-Once you've finished editing the batch file, you can save it and run it with SLURM:
+Once you've finished editing the batch file, you can save it and run it with Slurm:
 
 ```console
 $ sbatch ./gemma-inference.sbatch

docs/running/jobreport.md

@@ -56,9 +56,9 @@ The report is divided into two parts: a general summary and GPU specific values.
 | Field | Description |
 | ----- | ----------- |
 | Job Id | The Slurm job id |
-| Step Id | The slurm step id. A job step in SLURM is a subdivision of a job started with srun |
+| Step Id | The slurm step id. A job step in Slurm is a subdivision of a job started with srun |
 | User | The user account that submitted the job |
-| SLURM Account | The project account that will be billed |
+| Slurm Account | The project account that will be billed |
 | Start Time, End Time, Elapsed Time | The time the job started and ended, and how long it ran |
 | Number of Nodes | The number of nodes allocated to the job |
 | Number of GPUs | The number of GPUs allocated to the job |
@@ -95,7 +95,7 @@ Summary of Job Statistics
 +-----------------------------------------+-----------------------------------------+
 | User                                    | jpcoles                                 |
 +-----------------------------------------+-----------------------------------------+
-| SLURM Account                           | unknown_account                         |
+| Slurm Account                           | unknown_account                         |
 +-----------------------------------------+-----------------------------------------+
 | Start Time                              | 03-07-2024 15:32:24                     |
 +-----------------------------------------+-----------------------------------------+
@@ -134,8 +134,8 @@ GPU Specific Values
     If the application crashes or the job is killed by `slurm` prematurely, `jobreport` will not be able to write any output.
 
 !!! warning "Too many GPUs reported by `jobreport`"
-    If the job reporting utility reports more GPUs than you expect from the number of nodes requested by SLURM, you may be missing options to set the visible devices correctly for your job.
-    See the [GH200 SLURM documentation][ref-slurm-gh200] for examples on how to expose GPUs correctly in your job.
+    If the job reporting utility reports more GPUs than you expect from the number of nodes requested by Slurm, you may be missing options to set the visible devices correctly for your job.
+    See the [GH200 Slurm documentation][ref-slurm-gh200] for examples on how to expose GPUs correctly in your job.
     When oversubscribing ranks to GPUs, the utility will always report too many GPUs.
     The utility does not combine data for the same GPU from different ranks.
 
@@ -207,7 +207,7 @@ Summary of Job Statistics
 +-----------------------------------------+-----------------------------------------+
 | User                                    | jpcoles                                 |
 +-----------------------------------------+-----------------------------------------+
-| SLURM Account                           | unknown_account                         |
+| Slurm Account                           | unknown_account                         |
 +-----------------------------------------+-----------------------------------------+
 | Start Time                              | 03-07-2024 14:54:48                     |
 +-----------------------------------------+-----------------------------------------+

docs/services/firecrest.md

@@ -428,7 +428,7 @@ A staging area is used for external transfers and downloading/uploading a file f
         ```
 !!! Note "Job submission through FirecREST"
 
-    FirecREST provides an abstraction for job submission using in the backend the SLURM scheduler of the vCluster.
+    FirecREST provides an abstraction for job submission using in the backend the Slurm scheduler of the vCluster.
 
     When submitting a job via the different [endpoints](https://firecrest.readthedocs.io/en/latest/reference.html#compute), you should pass the `-l` option to the `/bin/bash` command on the batch file.
 

docs/software/communication/cray-mpich.md

@@ -35,7 +35,7 @@ This means that Cray MPICH will automatically be linked to the GTL library, whic
 
 In addition to linking to the GTL library, Cray MPICH must be configured to be GPU-aware at runtime by setting the `MPICH_GPU_SUPPORT_ENABLED=1` environment variable.
 On some CSCS systems this option is set by default.
-See [this page][ref-slurm-gh200] for more information on configuring SLURM to use GPUs.
+See [this page][ref-slurm-gh200] for more information on configuring Slurm to use GPUs.
 
 !!! warning "Segmentation faults when trying to communicate GPU buffers without `MPICH_GPU_SUPPORT_ENABLED=1`"
     If you attempt to communicate GPU buffers through MPI without setting `MPICH_GPU_SUPPORT_ENABLED=1`, it will lead to segmentation faults, usually without any specific indication that it is the communication that fails.

docs/software/ml/pytorch.md

@@ -315,9 +315,9 @@ $ exit # (6)!
 Alternatively one can use the uenv as [upstream Spack instance][ref-building-uenv-spack] to to add both Python and non-Python packages.
 However, this workflow is more involved and intended for advanced Spack users.
 
-## Running PyTorch jobs with SLURM
+## Running PyTorch jobs with Slurm
 
-```bash title="slurm sbatch script"
+```bash title="Slurm sbatch script"
 #!/bin/bash
 #SBATCH --job-name=myjob
 #SBATCH --nodes=1
@@ -383,7 +383,7 @@ srun bash -c "
 6. Disable GPU support in MPICH, as it [can lead to deadlocks](https://docs.nvidia.com/deeplearning/nccl/user-guide/docs/mpi.html#inter-gpu-communication-with-cuda-aware-mpi) when using together with nccl.
 7. Avoid writing JITed binaries to the (distributed) file system, which could lead to performance issues.
 8. These variables should always be set for correctness and optimal performance when using NCCL, see [the detailed explanation][ref-communication-nccl].
-9. `RANK` and `LOCAL_RANK` are set per-process by the SLURM job launcher.
+9. `RANK` and `LOCAL_RANK` are set per-process by the Slurmjob launcher.
 10. Activate the virtual environment created on top of the uenv (if any).
    Please follow the guidelines for [python virtual environments with uenv][ref-guides-storage-venv] to enhance scalability and reduce load times.