Skip to content

Commit

Permalink
Update existing Doc on how to use EESSI
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Top committed Oct 9, 2024
1 parent 48e46e0 commit 4e72953
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/using_eessi/setting_up_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,31 @@

To set up the EESSI environment, either use EESSI with Lmod:

A. If already using Lmod version >= 8.6, consider unsetting the MODULEPATH:

``` { .bash .copy }
export MODULEPATH=/cvmfs/software.eessi.io/init/modules:$MODULEPATH
unset MODULEPATH
export MODULEPATH=/cvmfs/software.eessi.io/init/modules
module load EESSI/2023.06
```
NOTE: Existing loaded modules may impact the EESSI environment.

Should Lmod be unavailable, you can still use EESSI as a module by directly sourcing the initialization script:
:clap: Your environment is now set up, you are ready to start running software provided by EESSI!

B. If using an older version of Lmod or any other tool utilizing MODULEPATH, unset MODULEPATH to prevent Lmod from attempting to build a cache:

``` { .bash .copy }
unset MODULEPATH
source /cvmfs/software.eessi.io/versions/2023.06/init/lmod/bash
```

:clap: Your environment is now set up, you are ready to start running software provided by EESSI!

C. Should Lmod be unavailable and MODULEPATH not utilized, you can use EESSI as a module by directly sourcing the initialization script:

``` { .bash .copy }
source /cvmfs/software.eessi.io/versions/2023.06/init/lmod/bash
```

:clap: Your environment is now set up, you are ready to start running software provided by EESSI!

Or use EESSI by running the command:
Expand Down

0 comments on commit 4e72953

Please sign in to comment.