Skip to content

Add instruction to access the development version of EESSI #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 4, 2025
+122 −108
Merged

Add instruction to access the development version of EESSI #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
13dc0f4
[eessi] Add information about accessing development versions
gkaf89 Nov 3, 2025
649e8d6
[REFACTOR:eessi] Move EESSI to the environment section
gkaf89 Nov 3, 2025
7a43acd
[REFACTOR] Remove redundant spaces
gkaf89 Nov 3, 2025
00db38e
[REFACTOR:eessi] Use display space more efficiently
gkaf89 Nov 3, 2025
3956e26
[REFACTOR:eessi] Use the console tag instead of explaining the code s…
gkaf89 Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions docs/software/eessi.md → docs/environment/eessi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# EESSI - European Environment for Scientific Software Installations

[<img width='400px' src='https://www.eessi.io/docs/img/logos/EESSI_logo_horizontal.jpg'/>](https://www.eessi.io/)
[<img width='400px' style='float:left' src='https://www.eessi.io/docs/img/logos/EESSI_logo_horizontal.jpg'/>](https://www.eessi.io/)

The [European Environment for Scientific Software Installations (EESSI, pronounced as "easy")](https://www.eessi.io/) is a collaboration between different European partners in HPC community.
The goal of this project is to build a common stack of scientific software installations for HPC systems and beyond, including laptops, personal workstations and cloud infrastructure.
Expand All @@ -10,24 +10,22 @@ The EESSI software stack is available on the ULHPC platform, and gives you acces

On a compute node, to set up the EESSI environment, simply load the EESSI [module](/environment/modules/):

```
```bash
module load EESSI
```

The first usage may be slow as the files are downloaded from an upstream Stratum 1 server, but the files are cached locally.

You should see the following output:

```
```console
$ module load EESSI
EESSI/2023.06 loaded successfully
```

The last line is the shell output.

Your environment is now set up, you are ready to start running software provided by EESSI! To see which modules (and extensions) are available, run:

```
```bash
module avail
```

Expand All @@ -41,4 +39,20 @@ Here is a short excerpt of the output produced by module avail:
...
```

??? note "Accessing development versions of EESSI"
New releases of EESSI are hidden while they are under development. However, you can still access the hidden modules. To view releases under development enable reporting of hidden modules, with
```console
$ module --show_hidden avail
```
or
```console
$ module --show_hidden avail EESSI
```
to search specifically for EESSI. You can load a hidden module by providing the full name of the module, for instance
```console
$ module load EESSI/2025.06
```
even though autocompletion will not work for hidden module names.


For more precise information, please refer to the [official documentation](https://www.eessi.io/docs).
2 changes: 1 addition & 1 deletion docs/environment/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ In UL HPC we are using environment meta-modules to modify the available module s
There are two types of software sets.

- _Modules under_ `env`: this is a set of modules optimized for the UL HPC systems. The modules are designed to load a different natively optimized set of modules for each system in UL HPC.
- _Modules under_ [`EESSI`](/software/eessi): this modules load EESSI software sets. The software sets distributed under EESSI provide binaries generically optimized for a number of architectures. The EESSI modules are design to provide a uniform collection of software sets across multiple HPC center to support reproducibility.
- _Modules under_ [`EESSI`](/environment/eessi): this modules load EESSI software sets. The software sets distributed under EESSI provide binaries generically optimized for a number of architectures. The EESSI modules are design to provide a uniform collection of software sets across multiple HPC center to support reproducibility.

!!! important "When to use EESSI modules"

Expand Down
202 changes: 101 additions & 101 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ nav:
- Getting Started: 'getting-started.md'
- HPC Trainings and Tutorials: 'hpc-schools.md'
- Accounts:
- Get an Account: 'accounts/index.md'
- Password Policy: 'policies/passwords.md'
- Collaboration Accounts: 'accounts/collaboration_accounts.md'
- Projects Accounts: 'accounts/projects.md'
- Get an Account: 'accounts/index.md'
- Password Policy: 'policies/passwords.md'
- Collaboration Accounts: 'accounts/collaboration_accounts.md'
- Projects Accounts: 'accounts/projects.md'
- Identity Management Portal: 'connect/ipa.md'
- Slurm Account Hierarchy: 'slurm/accounts.md'
- Slurm Account Hierarchy: 'slurm/accounts.md'
- Teaching with the ULHPC: 'teaching-with-the-ulhpc.md'
##############
- Data Center:
Expand All @@ -20,15 +20,15 @@ nav:
- ULHPC Supercomputers:
- Overview: 'systems/index.md'
- Aion:
- Aion System: 'systems/aion/index.md'
- Aion System: 'systems/aion/index.md'
- Compute Nodes: 'systems/aion/compute.md'
- Fast Local Interconnect: 'systems/aion/interconnect.md'
- Timeline: 'systems/aion/timeline.md'
- Timeline: 'systems/aion/timeline.md'
- Iris:
- Iris System: 'systems/iris/index.md'
- Iris System: 'systems/iris/index.md'
- Compute Nodes: 'systems/iris/compute.md'
- Fast Local Interconnect: 'systems/iris/interconnect.md'
- Timeline: 'systems/iris/timeline.md'
- Timeline: 'systems/iris/timeline.md'
- Grid'5000:
- Getting started: 'g5k/getting-started-g5k.md'
- Luxembourg site: 'https://www.grid5000.fr/w/Luxembourg:Home'
Expand All @@ -37,48 +37,49 @@ nav:
#######################
- Interconnect:
- Fast Infiniband Interconnect: 'interconnect/ib.md'
- Ethernet Interconnect: 'interconnect/ethernet.md'
- Ethernet Interconnect: 'interconnect/ethernet.md'
#######################
- Storage:
- Overview: 'filesystems/index.md'
- Data Sharing: 'data/sharing.md'
- Data Transfer: 'data/transfer.md'
- Project Data Management: 'data/project.md'
- Scratch Data Management: 'filesystems/lfs.md'
- Quotas: 'filesystems/quotas.md'
- Backups: 'data/backups.md'
# - Archiving: 'data/archiving.md'
- Unix File Permissions: 'filesystems/unix-file-permissions.md'
# - Version Control with Git: 'workflow/git.md'
- Datasets: 'data/datasets.md'
- GDPR Compliance: 'data/gdpr.md'
- Sensitive Data Protection: 'data/encryption.md'
- Overview: 'filesystems/index.md'
- Data Sharing: 'data/sharing.md'
- Data Transfer: 'data/transfer.md'
- Project Data Management: 'data/project.md'
- Scratch Data Management: 'filesystems/lfs.md'
- Quotas: 'filesystems/quotas.md'
- Backups: 'data/backups.md'
# - Archiving: 'data/archiving.md'
- Unix File Permissions: 'filesystems/unix-file-permissions.md'
# - Version Control with Git: 'workflow/git.md'
- Datasets: 'data/datasets.md'
- GDPR Compliance: 'data/gdpr.md'
- Sensitive Data Protection: 'data/encryption.md'
- Clustered and Networked File Systems:
- GPFS/SpectrumScale: 'filesystems/gpfs.md'
- Lustre: 'filesystems/lustre.md'
- OneFS Isilon: 'filesystems/isilon.md'
- GPFS/SpectrumScale: 'filesystems/gpfs.md'
- Lustre: 'filesystems/lustre.md'
- OneFS Isilon: 'filesystems/isilon.md'
#################
- Access/Connect:
- Access/Login Servers: 'connect/access.md'
- SSH: 'connect/ssh.md'
- SSH (Windows): 'connect/windows.md'
- Access/Login Servers: 'connect/access.md'
- SSH: 'connect/ssh.md'
- SSH (Windows): 'connect/windows.md'
- Identity Management (IdM/IPA): 'connect/ipa.md'
- Open On Demand Portal: 'connect/ood.md'
- Troubleshooting: 'connect/troubleshooting.md'
- Open On Demand Portal: 'connect/ood.md'
- Troubleshooting: 'connect/troubleshooting.md'

# - Multi-Factor Authentication: 'connect/mfa.md'
##############
- Environment:
- Overview: 'environment/index.md'
- Modules: 'environment/modules.md'
- Easybuild: 'environment/easybuild.md'
- Overview: 'environment/index.md'
- Modules: 'environment/modules.md'
- Easybuild: 'environment/easybuild.md'
- EESSI software stack: 'environment/eessi.md'
- Containers: 'environment/containers.md'
- Conda: 'environment/conda.md'
- Conda: 'environment/conda.md'
###########
- Policies:
- Acceptable Use Policy (AUP): 'policies/aup.md'
- Downtime and Maintenance: 'policies/maintenance.md'
- Usage Charging Policy: 'policies/usage-charging.md'
- Acceptable Use Policy (AUP): 'policies/aup.md'
- Downtime and Maintenance: 'policies/maintenance.md'
- Usage Charging Policy: 'policies/usage-charging.md'
###############
- Running Jobs:
- Slurm Overview: 'slurm/index.md'
Expand Down Expand Up @@ -148,12 +149,11 @@ nav:
- 2019b: 'software/swsets/2019b.md'
- 2020a: 'software/swsets/2020b.md'
### END GENERATED CONTENT
# - Software Set Versioning: 'software/swsets.md'
# - Software Set Versioning: 'software/swsets.md'
- Compiling/building your own software: 'software/build.md'
- EESSI software stack: 'software/eessi.md'
# - Management: 'software/management.md'
# - Contributing: 'software/contributing.md'
# - BigData Analytics: 'software/bigdata/index.md'
# - Management: 'software/management.md'
# - Contributing: 'software/contributing.md'
# - BigData Analytics: 'software/bigdata/index.md'
# - Bioinformatics/Life Science: 'software/bio/index.md'
- Computer Aided Eng. (CAE):
- FEniCS : 'software/cae/fenics.md'
Expand All @@ -166,94 +166,94 @@ nav:
- WRF: 'software/physics/wrf.md'
- Computational Chemistry:
- Electronics:
- ABINIT: 'software/computational-chemistry/electronics/abinit.md'
- ASE: 'software/computational-chemistry/electronics/ase.md'
- MEEP: 'software/computational-chemistry/electronics/meep.md'
- Quantum Espresso: 'software/computational-chemistry/electronics/quantum-espresso.md'
- VASP: 'software/computational-chemistry/electronics/vasp.md'
- ABINIT: 'software/computational-chemistry/electronics/abinit.md'
- ASE: 'software/computational-chemistry/electronics/ase.md'
- MEEP: 'software/computational-chemistry/electronics/meep.md'
- Quantum Espresso: 'software/computational-chemistry/electronics/quantum-espresso.md'
- VASP: 'software/computational-chemistry/electronics/vasp.md'
- Molecular Dynamics:
- CP2K: 'software/computational-chemistry/molecular-dynamics/cp2k.md'
- GROMACS: 'software/computational-chemistry/molecular-dynamics/gromacs.md'
- NAMD: 'software/computational-chemistry/molecular-dynamics/namd.md'
- NWCHEM: 'software/computational-chemistry/molecular-dynamics/nwchem.md'
- Helping Libraries: 'software/computational-chemistry/molecular-dynamics/helping-libraries.md'
# - Deep and Machine Learning: 'software/ml/index.md'
# - Earth Sciences: 'software/geo/index.md'
# - Deep and Machine Learning: 'software/ml/index.md'
# - Earth Sciences: 'software/geo/index.md'
- Mathematics & Statistics:
- MATLAB: 'software/maths/matlab.md'
- MATHEMATICA: 'software/maths/mathematica.md'
- MATLAB: 'software/maths/matlab.md'
- MATHEMATICA: 'software/maths/mathematica.md'
- Stata: 'software/maths/stata.md'
- Julia: 'software/maths/julia.md'
- Optimizers: 'software/optim/index.md'
# - Performance/Debugging: 'development/performance-debugging-tools/index.md'
# - Physics: 'software/phys/index.md'
# - Toolchains/Compilers: 'development/toolchains/index.md'
- Julia: 'software/maths/julia.md'
- Optimizers: 'software/optim/index.md'
# - Performance/Debugging: 'development/performance-debugging-tools/index.md'
# - Physics: 'software/phys/index.md'
# - Toolchains/Compilers: 'development/toolchains/index.md'
- Visualization:
- ParaView: 'software/visu/paraview.md'
- ParaView: 'software/visu/paraview.md'

##############
- Development:
# - Toolchains and Compilers:
# - Overview: 'development/toolchains/index.md'
# - FOSS: 'development/toolchains/foss.md'
# - Intel: 'development/toolchains/intel.md'
# - LLVM: 'development/compilers/llvm.md'
# - PGI: 'development/compilers/pgi.md'
# - FOSS: 'development/toolchains/foss.md'
# - Intel: 'development/toolchains/intel.md'
# - LLVM: 'development/compilers/llvm.md'
# - PGI: 'development/compilers/pgi.md'
# - Build Tools:
# - Autoconf and Make: 'development/build-tools/autoconf-make.md'
# - CMake: 'development/build-tools/cmake.md'
# - EasyBuild: 'development/build-tools/easybuild.md'
# - Spack: 'https://spack-tutorial.readthedocs.io/en/latest/'
# - CMake: 'development/build-tools/cmake.md'
# - EasyBuild: 'development/build-tools/easybuild.md'
# - Spack: 'https://spack-tutorial.readthedocs.io/en/latest/'
# - Programming Models:
# - Overview: 'development/programming-models/index.md'
# - MPI Stack:
# - About: 'development/programming-models/mpi/index.md'
# - About: 'development/programming-models/mpi/index.md'
# - OpenMPI: 'development/programming-models/mpi/openmpi.md'
# - OpenMP: 'development/programming-models/openmp/openmp.md'
# - CUDA: 'development/programming-models/cuda.md'
# - Kokkos : 'development/programming-models/kokkos.md'
# - UPC : 'development/programming-models/upc.md'
# - OpenMP: 'development/programming-models/openmp/openmp.md'
# - CUDA: 'development/programming-models/cuda.md'
# - Kokkos: 'development/programming-models/kokkos.md'
# - UPC: 'development/programming-models/upc.md'
# - Languages:
# - Go: 'development/languages/go.md'
# - Java: 'development/languages/java.md'
# - Go: 'development/languages/go.md'
# - Java: 'development/languages/java.md'
# - Julia: 'development/languages/julia.md'
# - Python:
# - About: 'development/languages/python/index.md'
# - Virtual Env.: 'development/languages/python/venv.md'
# - Best Practices: 'development/languages/python/best-practices.md'
# - Python on GPU: 'development/languages/python/python-on-gpu.md'
# - Scaling Up: 'development/languages/python/scaling-up.md'
# - Multiprocessing: 'development/languages/python/multiprocessing.md'
# - mpi4py: 'development/languages/python/mpi4py.md'
# - Notebook: 'development/languages/python/notebook.md'
# - About: 'development/languages/python/index.md'
# - Virtual Env.: 'development/languages/python/venv.md'
# - Best Practices: 'development/languages/python/best-practices.md'
# - Python on GPU: 'development/languages/python/python-on-gpu.md'
# - Scaling Up: 'development/languages/python/scaling-up.md'
# - Multiprocessing: 'development/languages/python/multiprocessing.md'
# - mpi4py: 'development/languages/python/mpi4py.md'
# - Notebook: 'development/languages/python/notebook.md'
# - Python Profiling: 'development/languages/python/profiling.md'
# - Python FAQ: 'development/languages/python/faq.md'
# - R: 'development/languages/r.md'
# - Python FAQ: 'development/languages/python/faq.md'
# - R: 'development/languages/r.md'
# - Ruby: 'development/languages/ruby.md'
# - Rust: 'development/languages/rust.md'
# - Libraries:
# - About: 'development/libraries/index.md'
# - About: 'development/libraries/index.md'
# - Boost C++: 'development/libraries/boost.md'
# - FFTW : 'development/libraries/fftw.md'
# - HDF5 : 'development/libraries/hdf5.md'
# - LAPACK : 'development/libraries/lapack.md'
# - MKL : 'development/libraries/mkl.md'
# - NetCDF : 'development/libraries/netcdf.md'
# - FFTW: 'development/libraries/fftw.md'
# - HDF5: 'development/libraries/hdf5.md'
# - LAPACK: 'development/libraries/lapack.md'
# - MKL: 'development/libraries/mkl.md'
# - NetCDF: 'development/libraries/netcdf.md'
- Performance/Debugging:
# - About: 'development/performance-debugging-tools/index.md'
- Arm Forge: 'development/performance-debugging-tools/arm-forge.md'
# - GDB: 'development/performance-debugging-tools/gdb.md'
- Intel VTune: 'development/performance-debugging-tools/vtune.md'
- Intel Advisor: 'development/performance-debugging-tools/advisor.md'
# - About: 'development/performance-debugging-tools/index.md'
- Arm Forge: 'development/performance-debugging-tools/arm-forge.md'
# - GDB: 'development/performance-debugging-tools/gdb.md'
- Intel VTune: 'development/performance-debugging-tools/vtune.md'
- Intel Advisor: 'development/performance-debugging-tools/advisor.md'
- Intel Inspector: 'development/performance-debugging-tools/inspector.md'
- Intel Trace Analyzer and Collector: 'development/performance-debugging-tools/itac.md'
# - LIKWID: 'development/performance-debugging-tools/likwid.md'
# - Nvidia Nsight: 'development/performance-debugging-tools/nsight.md'
# - LIKWID: 'development/performance-debugging-tools/likwid.md'
# - Nvidia Nsight: 'development/performance-debugging-tools/nsight.md'
# - Roofline Performance Model: 'development/performance-debugging-tools/roofline.md'
# - PAPI: 'development/performance-debugging-tools/papi.md'
- Scalasca: 'development/performance-debugging-tools/scalasca.md'
- Valgrind: 'development/performance-debugging-tools/valgrind.md'
- APS: 'development/performance-debugging-tools/aps.md'
# - PAPI: 'development/performance-debugging-tools/papi.md'
- Scalasca: 'development/performance-debugging-tools/scalasca.md'
- Valgrind: 'development/performance-debugging-tools/valgrind.md'
- APS: 'development/performance-debugging-tools/aps.md'
###############
# - Applications:
# - Overview: 'software/index.md'
Expand Down Expand Up @@ -407,8 +407,8 @@ markdown_extensions:
- pymdownx.details
# Icons from Emoji extensions, giving access to following icon sets:
# - Material Design: https://materialdesignicons.com/
# - FontAwesome: https://fontawesome.com/icons?d=gallery&m=free
# – Octicons: https://octicons.github.com/
# - FontAwesome: https://fontawesome.com/icons?d=gallery&m=free
# – Octicons: https://octicons.github.com/
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
Expand Down