From 6986befc1df956c8bb2486c72e123e68caf12019 Mon Sep 17 00:00:00 2001
From: Luis C <luis.casillas@tuwien.ac.at>
Date: Tue, 14 Jan 2025 10:36:53 +0100
Subject: [PATCH] added an eessi page in software
---
docs/running_jobs/parjobs.md | 2 +-
docs/software/eessi.md | 71 ++++++++++++++++++++++++++++++++++++
docs/support/support.md | 2 +-
mkdocs.yml | 1 +
4 files changed, 74 insertions(+), 2 deletions(-)
create mode 100644 docs/software/eessi.md
diff --git a/docs/running_jobs/parjobs.md b/docs/running_jobs/parjobs.md
index 60c0ab9..140aa12 100644
--- a/docs/running_jobs/parjobs.md
+++ b/docs/running_jobs/parjobs.md
@@ -152,7 +152,7 @@ application, follow these steps:
- Additional Resources: Explore MPI tutorials at: [VSC training
events](https://vsc.ac.at/research/vsc-research-center/vsc-school-seminar/)
-The default pin processor list is given by \<color
+The default pin processor list is given by
<span style="color:red">0,1,...,n</span> (n is the last core of a computing node).
### Examples
diff --git a/docs/software/eessi.md b/docs/software/eessi.md
new file mode 100644
index 0000000..3f3b7ff
--- /dev/null
+++ b/docs/software/eessi.md
@@ -0,0 +1,71 @@
+# EESSI
+
+!!! Tip "EESSI modules are now available on VSC systems!"
+
+The European Environment for Scientific Software Installations (EESSI, pronounced as "easy") is a collaboration between different HPC sites and industry partners, with the common goal to set up a shared repository of scientific software installations that can be used on a variety of systems, regardless of which flavor/version of Linux distribution or processor architecture is used, or whether it is a full-size HPC cluster, a cloud environment or a personal workstation, and without compromising on the performance of the software.
+
+Read more about EESSI [here](https://www.eessi.io/){:target="_blank"}.
+
+## EESSI on VSC
+
+### Start EESSI
+
+Type `eessi` in your login terminal:
+
+```{.bash .numberLines startFrom=""}
+zen trainee00@l55:~$ eessi
+Found EESSI repo @ /cvmfs/software.eessi.io/versions/2023.06!
+archdetect says x86_64/amd/zen3
+Prepending /cvmfs/software.eessi.io/versions/2023.06/software/linux...
+Environment set up to use EESSI (2023.06), have fun!
+{EESSI 2023.06} trainee00@l55:~$
+```
+Note how the prompt now shows the **{EESSI 2023.06}** env.
+
+!!! Warning
+ Currently there is **no way** to get _out_ of EESSI, you have to login again.
+ We are working on improving on this
+
+### Overview of all EESSI modules
+
+Type `ml ov` to show all the EESSI available modules:
+
+```{.bash .numberLines startFrom=""}
+{EESSI 2023.06} trainee00@l55:~$ ml ov
+
+---/cvmfs/software.eessi.io/versions/2023.06/... ----
+Abseil (2) Eigen (3)
+ALL (1) elfutils (2)
+amdahl (1) ELPA (2)
+```
+
+Where (2) means two versions are installed.
+
+Type `q` to get out of the list, or `page down` all the way.
+
+### Using the modules
+ EESSI uses to usual module commands:
+
+ Use `module avail` to find installations of a package.<br>
+ Use `module load` to load the module.<br>
+ Use `module list` to list all the loaded modules.<br>
+ Use `module purge` to remove all the loaded modules.<br>
+Use `module show` to inspect the module.
+
+## Using EESSI in a job script
+
+Here is an example on how to use EESSI modules inside a job script, one just needs to add the 'eessi' command
+and load the desired EESSI module:
+
+```
+#!/bin/bash
+#SBATCH -J test_job
+#SBATCH -N 1
+#SBATCH --partition zen3_0512
+#SBATCH --qos zen3_0512
+
+eessi
+module load lammps #for example
+srun lmp -i in.meam
+```
+
diff --git a/docs/support/support.md b/docs/support/support.md
index a6e1df8..2d08b66 100644
--- a/docs/support/support.md
+++ b/docs/support/support.md
@@ -60,5 +60,5 @@ Please do not send support questions directly to VSC staff's personal email addr
##VSC user community
We have established a way for our users to talk to each other and help or advise other users without havint to involve the VSC team. This is done via the open, federated and institution-independent chat tool Matrix.
-Our VSC-user space can be joined [here](https://matrix.tuwien.ac.at/#/room/#vsc:tuwien.ac.at)
+Our VSC-user space can be joined [here](https://matrix.tuwien.ac.at/#/room/#vsc:tuwien.ac.at).
If you do not have an account yet, one can be created for free at [matrix.org](https://matrix.org/try-matrix/)
diff --git a/mkdocs.yml b/mkdocs.yml
index 1525691..8f486ff 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -44,6 +44,7 @@ nav:
- software/index.md
- Module system: software/modules.md
- Compilers: software/compilers.md
+ - EESSI: software/eessi.md
- Python:
- Using Conda: software/python/conda.md
- Using Venv: software/python/python_venv.md
--
GitLab