Apply suggestions from code review

Applied Adam's suggestions from code review Co-authored-by: Adam Tyson <[email protected]>
neuroinformatics-unit · Nov 23, 2023 · 5ce71ba · 5ce71ba
1 parent fa423a2
commit 5ce71ba
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/docs/source/data_analysis/HPC-module-SLEAP.md b/docs/source/data_analysis/HPC-module-SLEAP.md
@@ -1,4 +1,4 @@
-# Use the SLEAP module on the HPC cluster
+# Use the SLEAP module on the SWC HPC cluster
 
 ```{include} ../_static/swc-wiki-warning.md
 ```
@@ -35,8 +35,8 @@ SLEAP/2023-03-13
 SLEAP/2023-08-01
 ...
 ```
-- `SLEAP/2023-03-13` corresponds to `sleap v.1.2.9`
-- `SLEAP/2023-08-01` corresponds to `sleap v.1.3.1`
+- `SLEAP/2023-03-13` corresponds to `SLEAP v.1.2.9`
+- `SLEAP/2023-08-01` corresponds to `SLEAP v.1.3.1`
 
 We recommend always using the latest version, which is the one loaded by default
 when you run `module load SLEAP`. If you want to load a specific version,

diff --git a/docs/source/programming/SLURM-arguments.md b/docs/source/programming/SLURM-arguments.md
@@ -69,20 +69,19 @@ For a more detailed description see the [SLURM documentation](https://slurm.sche
 - *Example values:* `1`
 
 :::{warning}
-This should always be `1`, unless you really know what you're doing,
-e.g. you are parallelising your code across multiple nodes with MPI.
+This is usually `1` unless you're parallelising your code across multiple nodes with technologies such as MPI.
 :::
 
 ### Number of Cores
 - *Name:* `--ntasks`
 - *Alias:* `-n`
 - *Description:* Defines the number of cores (or tasks) required for the job.
-- *Example values:* `4`, `8`, `16`
+- *Example values:* `1`, `5`, `20`
 
 ### Memory Pool for All Cores
 - *Name:* `--mem`
 - *Description:* Specifies the total amount of memory (RAM) required for the job across all cores (per node)
-- *Example values:* `8G`, `32G`, `64G`
+- *Example values:* `4G`, `32G`, `64G`
 
 ### Time Limit
 - *Name:* `--time`
@@ -94,6 +93,8 @@ e.g. you are parallelising your code across multiple nodes with MPI.
 If the job exceeds the time limit, it will be terminated by SLURM.
 On the other hand, avoid requesting way more time than what your job needs,
 as this may delay its scheduling (depending on resource availability).
+
+If needed, the systems administrator can extend long-running jobs. 
 :::
 
 ### Generic Resources (GPUs)