From f0d7093e7b0c9f5b855cdf86d9230401051519f0 Mon Sep 17 00:00:00 2001 From: Richard Top Date: Wed, 22 Oct 2025 11:53:50 +0200 Subject: [PATCH 1/2] Add EESSI-env-variables to docs --- docs/using_eessi/setting_up_environment.md | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/using_eessi/setting_up_environment.md b/docs/using_eessi/setting_up_environment.md index f474d68823..44634bbfc5 100644 --- a/docs/using_eessi/setting_up_environment.md +++ b/docs/using_eessi/setting_up_environment.md @@ -206,6 +206,41 @@ $ module av # ... ``` +??? tip "Environment variables to consider while initializing EESSI" + + ### Source-based Initialization + + | Environment variable | Description | + |-----------------------|------------------------| + | `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. | + | `EESSI_BASIC_ENV` | When set to 1, performs a minimal init only exporting essential variables. | + | `EESSI_CVMFS_REPO_OVERRIDE` | Overrides the default CVMFS repository path (e.g. /cvmfs/software.eessi.io) used by init. | + | `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_ACCEL_SOFTWARE_SUBDIR_OVERRIDE` | Overrides CPU software subdir used specifically for accelerator stack modules. | + | `EESSI_MODULE_SUBDIR` | Overrides the module tree subdir to expose (e.g. modules/all or architecture-specific path). | + | `EESSI_CUSTOM_MODULEPATH` | Additional colon-separated module paths to prepend to MODULEPATH during module-based init. | + + ### 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. | + | `EESSI_CVMFS_REPO_OVERRIDE` | Overrides the default CVMFS repository path (e.g. /cvmfs/software.eessi.io) used by init. | + | `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_ACCEL_SOFTWARE_SUBDIR_OVERRIDE` | Overrides CPU software subdir used specifically for accelerator stack modules. | + | `LMOD_SYSTEM_DEFAULT_MODULES` | List of modules Lmod auto-loads on shell start; can include EESSI/2023.06 to auto-enable. | + | `EESSI_ARCHDETECT_OPTIONS` | Extra options passed to eessi_archdetect.sh (e.g. -d for debug, -a to list compatibles). | + | `EESSI_ARCHDETECT_OPTIONS_OVERRIDE` | Replaces any built-in archdetect options with the provided value. | + | `EESSI_ACCEL_SUBDIR` | Overrides accelerator module subdir (e.g. accel/nvidia/cc70) when using module-based init. | + | `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 From d7b2b597a8d97c5444fc52b7229a0ac857121bca Mon Sep 17 00:00:00 2001 From: Richard Top Date: Wed, 29 Oct 2025 16:42:20 +0100 Subject: [PATCH 2/2] removed some variables --- docs/using_eessi/setting_up_environment.md | 27 +++++++++------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/docs/using_eessi/setting_up_environment.md b/docs/using_eessi/setting_up_environment.md index 44634bbfc5..12004068ce 100644 --- a/docs/using_eessi/setting_up_environment.md +++ b/docs/using_eessi/setting_up_environment.md @@ -208,35 +208,30 @@ $ module av ??? tip "Environment variables to consider while initializing EESSI" - ### Source-based Initialization + ### OVERRIDING variables - | Environment variable | Description | + | Environment variables | Description | |-----------------------|------------------------| - | `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. | - | `EESSI_BASIC_ENV` | When set to 1, performs a minimal init only exporting essential variables. | | `EESSI_CVMFS_REPO_OVERRIDE` | Overrides the default CVMFS repository path (e.g. /cvmfs/software.eessi.io) used by init. | | `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_ACCEL_SOFTWARE_SUBDIR_OVERRIDE` | Overrides CPU software subdir used specifically for accelerator stack modules. | - | `EESSI_MODULE_SUBDIR` | Overrides the module tree subdir to expose (e.g. modules/all or architecture-specific path). | - | `EESSI_CUSTOM_MODULEPATH` | Additional colon-separated module paths to prepend to MODULEPATH during module-based init. | + | `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. | - | `EESSI_CVMFS_REPO_OVERRIDE` | Overrides the default CVMFS repository path (e.g. /cvmfs/software.eessi.io) used by init. | - | `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_ACCEL_SOFTWARE_SUBDIR_OVERRIDE` | Overrides CPU software subdir used specifically for accelerator stack modules. | | `LMOD_SYSTEM_DEFAULT_MODULES` | List of modules Lmod auto-loads on shell start; can include EESSI/2023.06 to auto-enable. | - | `EESSI_ARCHDETECT_OPTIONS` | Extra options passed to eessi_archdetect.sh (e.g. -d for debug, -a to list compatibles). | - | `EESSI_ARCHDETECT_OPTIONS_OVERRIDE` | Replaces any built-in archdetect options with the provided value. | - | `EESSI_ACCEL_SUBDIR` | Overrides accelerator module subdir (e.g. accel/nvidia/cc70) when using module-based init. | | `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. |