From aa5591100dc6ce07afeae1797d7d914c4f1d50be Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Thu, 24 Mar 2022 08:34:08 +0100
Subject: [PATCH] Resolve #300 by using the placeholder procjet title
p_number_crunch
---
.../docs/archive/install_jupyter.md | 2 +-
.../docs/contrib/content_rules.md | 15 ++++++++-------
.../docs/data_transfer/datamover.md | 4 ++--
.../docs/jobs_and_resources/slurm_examples.md | 2 +-
.../docs/software/building_software.md | 8 ++++----
.../docs/software/data_analytics_with_python.md | 6 +++---
.../docs/software/fem_software.md | 2 +-
doc.zih.tu-dresden.de/docs/software/papi.md | 8 ++++----
.../docs/software/private_modules.md | 8 ++++----
.../util/grep-forbidden-patterns.sh | 4 ++--
10 files changed, 30 insertions(+), 29 deletions(-)
diff --git a/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md b/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md
index 02b78701b..a1d296650 100644
--- a/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md
+++ b/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md
@@ -148,7 +148,7 @@ c.NotebookApp.allow_remote_access = True
#SBATCH --time=02:30:00
#SBATCH --mem=4000M
#SBATCH -J "jupyter-notebook" # job-name
-#SBATCH -A p_marie
+#SBATCH -A p_number_crunch
unset XDG_RUNTIME_DIR # might be required when interactive instead of sbatch to avoid 'Permission denied error'
srun jupyter notebook
diff --git a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md
index f054c5fa3..358cd1532 100644
--- a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+++ b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md
@@ -134,7 +134,7 @@ We follow this rules regarding prompts:
an example invocation, perhaps with output, should be given with the normal `console` code block.
See also [Code Block description below](#code-blocks-and-syntax-highlighting).
* Using some magic, the prompt as well as the output is identified and will not be copied!
-* Stick to the [generic user name](#data-privacy-and-generic-user-name) `marie`.
+* Stick to the [generic user name](#data-privacy-and-generic-names) `marie`.
### Code Blocks and Syntax Highlighting
@@ -245,16 +245,17 @@ _Result_:
-### Data Privacy and Generic User Name
+### Data Privacy and Generic Names
-Where possible, replace login, project name and other private data with clearly arbitrary placeholders.
-E.g., use the generic login `marie` and the corresponding project name `p_marie`.
+Where possible, replace login, project name and other private data with clearly arbitrary
+placeholders. In particular, use the generic login `marie` and the project title `p_number_crunch`
+as placeholders.
```console
marie@login$ ls -l
-drwxr-xr-x 3 marie p_marie 4096 Jan 24 2020 code
-drwxr-xr-x 3 marie p_marie 4096 Feb 12 2020 data
--rw-rw---- 1 marie p_marie 4096 Jan 24 2020 readme.md
+drwxr-xr-x 3 marie p_number_crunch 4096 Jan 24 2020 code
+drwxr-xr-x 3 marie p_number_crunch 4096 Feb 12 2020 data
+-rw-rw---- 1 marie p_number_crunch 4096 Jan 24 2020 readme.md
```
## Mark Omissions
diff --git a/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md b/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md
index 0bd3fbe88..a63971bb0 100644
--- a/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md
+++ b/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md
@@ -45,7 +45,7 @@ To identify the mount points of the different filesystems on the data transfer m
!!! example "Copying data from `/beegfs/global0` to `/projects` filesystem."
``` console
- marie@login$ dtcp -r /beegfs/global0/ws/marie-workdata/results /projects/p_marie/.
+ marie@login$ dtcp -r /beegfs/global0/ws/marie-workdata/results /projects/p_number_crunch/.
```
!!! example "Moving data from `/beegfs/global0` to `/warm_archive` filesystem."
@@ -57,7 +57,7 @@ To identify the mount points of the different filesystems on the data transfer m
!!! example "Archive data from `/beegfs/global0` to `/archiv` filesystem."
``` console
- marie@login$ dttar -czf /archiv/p_marie/results.tgz /beegfs/global0/ws/marie-workdata/results
+ marie@login$ dttar -czf /archiv/p_number_crunch/results.tgz /beegfs/global0/ws/marie-workdata/results
```
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_examples.md b/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_examples.md
index b6ec206cf..ebfd52972 100644
--- a/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_examples.md
+++ b/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_examples.md
@@ -109,7 +109,7 @@ for `sbatch/srun` in this case is `--gres=gpu:[NUM_PER_NODE]` (where `NUM_PER_NO
#SBATCH --cpus-per-task=6 # use 6 threads per task
#SBATCH --gres=gpu:1 # use 1 GPU per node (i.e. use one GPU per task)
#SBATCH --time=01:00:00 # run for 1 hour
- #SBATCH --account=p_marie # account CPU time to project p_marie
+ #SBATCH --account=p_number_crunch # account CPU time to project p_number_crunch
srun ./your/cuda/application # start you application (probably requires MPI to use both nodes)
```
diff --git a/doc.zih.tu-dresden.de/docs/software/building_software.md b/doc.zih.tu-dresden.de/docs/software/building_software.md
index c83932a16..73952b06e 100644
--- a/doc.zih.tu-dresden.de/docs/software/building_software.md
+++ b/doc.zih.tu-dresden.de/docs/software/building_software.md
@@ -17,16 +17,16 @@ For instance, when using CMake and keeping your source in `/projects`, you could
```console
# save path to your source directory:
-marie@login$ export SRCDIR=/projects/p_marie/mysource
+marie@login$ export SRCDIR=/projects/p_number_crunch/mysource
# create a build directory in /scratch:
-marie@login$ mkdir /scratch/p_marie/mysoftware_build
+marie@login$ mkdir /scratch/p_number_crunch/mysoftware_build
# change to build directory within /scratch:
-marie@login$ cd /scratch/p_marie/mysoftware_build
+marie@login$ cd /scratch/p_number_crunch/mysoftware_build
# create Makefiles:
-marie@login$ cmake -DCMAKE_INSTALL_PREFIX=/projects/p_marie/mysoftware $SRCDIR
+marie@login$ cmake -DCMAKE_INSTALL_PREFIX=/projects/p_number_crunch/mysoftware $SRCDIR
# build in a job:
marie@login$ srun --mem-per-cpu=1500 --cpus-per-task=12 --pty make -j 12
diff --git a/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md b/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md
index a7d278166..cf8c1b559 100644
--- a/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md
+++ b/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md
@@ -219,7 +219,7 @@ from dask_jobqueue import SLURMCluster
cluster = SLURMCluster(queue='alpha',
cores=8,
processes=2,
- project='p_marie',
+ project='p_number_crunch',
memory="8GB",
walltime="00:30:00")
@@ -242,7 +242,7 @@ from dask import delayed
cluster = SLURMCluster(queue='alpha',
cores=8,
processes=2,
- project='p_marie',
+ project='p_number_crunch',
memory="80GB",
walltime="00:30:00",
extra=['--resources gpu=1'])
@@ -294,7 +294,7 @@ for the Monte-Carlo estimation of Pi.
#create a Slurm cluster, please specify your project
- cluster = SLURMCluster(queue='alpha', cores=2, project='p_marie', memory="8GB", walltime="00:30:00", extra=['--resources gpu=1'], scheduler_options={"dashboard_address": f":{portdash}"})
+ cluster = SLURMCluster(queue='alpha', cores=2, project='p_number_crunch', memory="8GB", walltime="00:30:00", extra=['--resources gpu=1'], scheduler_options={"dashboard_address": f":{portdash}"})
#submit the job to the scheduler with the number of nodes (here 2) requested:
diff --git a/doc.zih.tu-dresden.de/docs/software/fem_software.md b/doc.zih.tu-dresden.de/docs/software/fem_software.md
index 3f9bf79d5..8b8eb4cfe 100644
--- a/doc.zih.tu-dresden.de/docs/software/fem_software.md
+++ b/doc.zih.tu-dresden.de/docs/software/fem_software.md
@@ -59,7 +59,7 @@ Slurm or [writing job files](../jobs_and_resources/slurm.md#job-files).
#SBATCH --job-name=yyyy # give a name, what ever you want
#SBATCH --mail-type=END,FAIL # send email when the job finished or failed
#SBATCH --mail-user=<name>@mailbox.tu-dresden.de # set your email
- #SBATCH --account=p_marie # charge compute time to project p_marie
+ #SBATCH --account=p_number_crunch # charge compute time to project p_number_crunch
# Abaqus has its own MPI
diff --git a/doc.zih.tu-dresden.de/docs/software/papi.md b/doc.zih.tu-dresden.de/docs/software/papi.md
index 7460e3dee..d8108bba3 100644
--- a/doc.zih.tu-dresden.de/docs/software/papi.md
+++ b/doc.zih.tu-dresden.de/docs/software/papi.md
@@ -105,11 +105,11 @@ multiple events, please check which events can be measured concurrently using th
The PAPI tools must be run on the compute node, using an interactive shell or job.
!!! example "Example: Determine the events on the partition `romeo` from a login node"
- Let us assume, that you are in project `p_marie`. Then, use the following commands:
+ Let us assume, that you are in project `p_number_crunch`. Then, use the following commands:
```console
marie@login$ module load PAPI
- marie@login$ salloc --account=p_marie --partition=romeo
+ marie@login$ salloc --account=p_number_crunch --partition=romeo
[...]
marie@compute$ srun papi_avail
marie@compute$ srun papi_native_avail
@@ -121,12 +121,12 @@ Instrument your application with either the high-level or low-level API. Load th
compile your application against the PAPI library.
!!! example
- Assuming that you are in project `p_marie`, use the following commands:
+ Assuming that you are in project `p_number_crunch`, use the following commands:
```console
marie@login$ module load PAPI
marie@login$ gcc app.c -o app -lpapi
- marie@login$ salloc --account=p_marie --partition=romeo
+ marie@login$ salloc --account=p_number_crunch --partition=romeo
marie@compute$ srun ./app
[...]
# Exit with Ctrl+D
diff --git a/doc.zih.tu-dresden.de/docs/software/private_modules.md b/doc.zih.tu-dresden.de/docs/software/private_modules.md
index 6dd2d3d04..00982700e 100644
--- a/doc.zih.tu-dresden.de/docs/software/private_modules.md
+++ b/doc.zih.tu-dresden.de/docs/software/private_modules.md
@@ -27,12 +27,12 @@ marie@compute$ cd privatemodules/<sw_name>
```
Project private module files for software that can be used by all members of your group should be
-located in your global projects directory, e.g., `/projects/p_marie/privatemodules`. Thus, create
+located in your global projects directory, e.g., `/projects/p_number_crunch/privatemodules`. Thus, create
this directory:
```console
-marie@compute$ mkdir --verbose --parents /projects/p_marie/privatemodules/<sw_name>
-marie@compute$ cd /projects/p_marie/privatemodules/<sw_name>
+marie@compute$ mkdir --verbose --parents /projects/p_number_crunch/privatemodules/<sw_name>
+marie@compute$ cd /projects/p_number_crunch/privatemodules/<sw_name>
```
!!! note
@@ -110,7 +110,7 @@ marie@login$ module use $HOME/privatemodules
for your private module files and
```console
-marie@login$ module use /projects/p_marie/privatemodules
+marie@login$ module use /projects/p_number_crunch/privatemodules
```
for group private module files, respectively.
diff --git a/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh b/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh
index b2f8b3478..cacde0d9e 100755
--- a/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh
+++ b/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh
@@ -46,9 +46,9 @@ i ^[ |]*|$
Avoid spaces at end of lines.
doc.zih.tu-dresden.de/docs/accessibility.md
i [[:space:]]$
-When referencing projects, please use p_marie for consistency.
+When referencing projects, please use p_number_crunch for consistency.
-i \<p_ p_marie
+i \<p_ p_number_crunch
Avoid \`home\`. Use home without backticks instead.
i \`home\`
--
GitLab