Skip to content

Commit a2d3d29

Browse files
authored
Merge pull request #601 from EESSI/EESSI-env-variables
Add EESSI-env-variables to docs
2 parents e62ad5d + d7b2b59 commit a2d3d29

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

docs/using_eessi/setting_up_environment.md

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

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

211241
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)