Skip to content

Add EESSI-env-variables to docs #601

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add EESSI-env-variables to docs #601

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0d7093
Add EESSI-env-variables to docs
Oct 22, 2025
d7b2b59
removed some variables
Oct 29, 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
30 changes: 30 additions & 0 deletions docs/using_eessi/setting_up_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,36 @@ $ module av
# ...
```

??? tip "Environment variables to consider while initializing EESSI"

### OVERRIDING variables

| Environment variables | Description |
|-----------------------|------------------------|
| `EESSI_CVMFS_REPO_OVERRIDE` | Overrides the default CVMFS repository path (e.g. /cvmfs/software.eessi.io) used by init. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything with *_OVERRIDE should be common to both, perhaps we should separate these (also avoids duplication). We should also consider the need for the rest...

| `EESSI_VERSION_OVERRIDE` | Overrides the default EESSI version subdirectory (e.g. 2023.06) selected by init. |
| `EESSI_SOFTWARE_SUBDIR_OVERRIDE` | Overrides detected CPU software subdir (e.g. linux/x86_64/intel/icelake) for the main stack. |
| `EESSI_ACCELERATOR_TARGET_OVERRIDE` | Overrides detected accelerator target (e.g. accel/nvidia/cc70) regardless of local hardware. |
| `EESSI_ARCHDETECT_OPTIONS_OVERRIDE` | Replaces any built-in archdetect options with the provided value. |

### Source-based Initialization

| Environment variable | Description |
|-----------------------|------------------------|
| `EESSI_BASIC_ENV` | When set to 1, performs a minimal init only exporting essential variables. |
| `EESSI_SILENT` | When set to 1, suppresses non-error output during source-based init; errors still print. |
| `EESSI_USE_ARCHDETECT` | When set to 0, disables automatic architecture detection using archdetect; otherwise detection is performed. |

### Module-based Initialization

| Environment variable | Description |
|-----------------------|------------------------|
| `EESSI_DEBUG_INIT` | When set to 1, enables verbose debug output from init scripts to trace decisions and paths. |
| `LMOD_SYSTEM_DEFAULT_MODULES` | List of modules Lmod auto-loads on shell start; can include EESSI/2023.06 to auto-enable. |
| `EESSI_MODULE_FAMILY_NAME` | Name of the family applied to the EESSI module (default EESSI); affects family conflicts. |
| `EESSI_MODULE_STICKY` | When set to 1, enables sticky behavior of the EESSI module. |


??? tip "The accelerator modules are visible but I can't load them"

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