Skip to content

Commit f0d7093

Browse files
author
Richard Top
committed
Add EESSI-env-variables to docs
1 parent 800e783 commit f0d7093

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

docs/using_eessi/setting_up_environment.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,41 @@ $ module av
206206
# ...
207207
```
208208

209+
??? tip "Environment variables to consider while initializing EESSI"
210+
211+
### Source-based Initialization
212+
213+
| Environment variable | Description |
214+
|-----------------------|------------------------|
215+
| `EESSI_SILENT` | When set to 1, suppresses non-error output during source-based init; errors still print. |
216+
| `EESSI_USE_ARCHDETECT` | When set to 0, disables automatic architecture detection using archdetect; otherwise detection is performed. |
217+
| `EESSI_BASIC_ENV` | When set to 1, performs a minimal init only exporting essential variables. |
218+
| `EESSI_CVMFS_REPO_OVERRIDE` | Overrides the default CVMFS repository path (e.g. /cvmfs/software.eessi.io) used by init. |
219+
| `EESSI_VERSION_OVERRIDE` | Overrides the default EESSI version subdirectory (e.g. 2023.06) selected by init. |
220+
| `EESSI_SOFTWARE_SUBDIR_OVERRIDE` | Overrides detected CPU software subdir (e.g. linux/x86_64/intel/icelake) for the main stack. |
221+
| `EESSI_ACCELERATOR_TARGET_OVERRIDE` | Overrides detected accelerator target (e.g. accel/nvidia/cc70) regardless of local hardware. |
222+
| `EESSI_ACCEL_SOFTWARE_SUBDIR_OVERRIDE` | Overrides CPU software subdir used specifically for accelerator stack modules. |
223+
| `EESSI_MODULE_SUBDIR` | Overrides the module tree subdir to expose (e.g. modules/all or architecture-specific path). |
224+
| `EESSI_CUSTOM_MODULEPATH` | Additional colon-separated module paths to prepend to MODULEPATH during module-based init. |
225+
226+
### Module-based Initialization
227+
228+
| Environment variable | Description |
229+
|-----------------------|------------------------|
230+
| `EESSI_DEBUG_INIT` | When set to 1, enables verbose debug output from init scripts to trace decisions and paths. |
231+
| `EESSI_CVMFS_REPO_OVERRIDE` | Overrides the default CVMFS repository path (e.g. /cvmfs/software.eessi.io) used by init. |
232+
| `EESSI_VERSION_OVERRIDE` | Overrides the default EESSI version subdirectory (e.g. 2023.06) selected by init. |
233+
| `EESSI_SOFTWARE_SUBDIR_OVERRIDE` | Overrides detected CPU software subdir (e.g. linux/x86_64/intel/icelake) for the main stack. |
234+
| `EESSI_ACCELERATOR_TARGET_OVERRIDE` | Overrides detected accelerator target (e.g. accel/nvidia/cc70) regardless of local hardware. |
235+
| `EESSI_ACCEL_SOFTWARE_SUBDIR_OVERRIDE` | Overrides CPU software subdir used specifically for accelerator stack modules. |
236+
| `LMOD_SYSTEM_DEFAULT_MODULES` | List of modules Lmod auto-loads on shell start; can include EESSI/2023.06 to auto-enable. |
237+
| `EESSI_ARCHDETECT_OPTIONS` | Extra options passed to eessi_archdetect.sh (e.g. -d for debug, -a to list compatibles). |
238+
| `EESSI_ARCHDETECT_OPTIONS_OVERRIDE` | Replaces any built-in archdetect options with the provided value. |
239+
| `EESSI_ACCEL_SUBDIR` | Overrides accelerator module subdir (e.g. accel/nvidia/cc70) when using module-based init. |
240+
| `EESSI_MODULE_FAMILY_NAME` | Name of the family applied to the EESSI module (default EESSI); affects family conflicts. |
241+
| `EESSI_MODULE_STICKY` | When set to 1, enables sticky behavior of the EESSI module. |
242+
243+
209244
??? tip "The accelerator modules are visible but I can't load them"
210245

211246
Do note that just because the accelerator modules are now visible doesn't mean you will be able to load them. EESSI

0 commit comments

Comments
 (0)