From 24ec2346aae2aa5a48b87c78d9ac997f9768c4f8 Mon Sep 17 00:00:00 2001 From: Samuel Moors Date: Mon, 7 Sep 2026 22:32:24 +0200 Subject: [PATCH 1/3] update test-suite reframe configfile docs --- docs/test-suite/ReFrame-configuration-file.md | 28 +++++++++++-------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/docs/test-suite/ReFrame-configuration-file.md b/docs/test-suite/ReFrame-configuration-file.md index 7eb6c88ac0..e9344461b6 100644 --- a/docs/test-suite/ReFrame-configuration-file.md +++ b/docs/test-suite/ReFrame-configuration-file.md @@ -63,7 +63,7 @@ The EESSI test suite standardizes a few string-based values as constants, as wel Every ReFrame configuration file used for running the EESSI test suite should therefore start with the following import statements: ```python -from eessi.testsuite.common_config import (common_eessi_init, common_general_config, common_logging_config, +from eessi.testsuite.common_config import (common_general_config, common_logging_config, set_common_required_config) from eessi.testsuite.constants import EXTRAS, FEATURES, SCALES, DEVICE_TYPES, GPU_VENDORS ``` @@ -141,10 +141,6 @@ site_configuration = { 'prepare_cmds': [ # Pass job environment variables like $PATH, etc., into job steps 'export SLURM_EXPORT_ENV=ALL', - # If your system doesn't have an Lmod installation by default on the batch nodes, - # uncommenting the following two lines will use one from EESSI. - # 'source /cvmfs/software.eessi.io/2025.06/init/lmod/bash', - # 'module unload EESSI', ], 'launcher': 'mpirun', 'access': ['-p cpu'], @@ -162,10 +158,6 @@ site_configuration = { 'prepare_cmds': [ # Pass job environment variables like $PATH, etc., into job steps 'export SLURM_EXPORT_ENV=ALL', - # If your system doesn't have an Lmod installation by default on the batch nodes, - # Uncommenting the following two lines will use one from EESSI. - # 'source /cvmfs/software.eessi.io/2025.06/init/lmod/bash', - # 'module unload EESSI', ], 'launcher': 'mpirun', 'access': ['-p gpu'], @@ -208,10 +200,10 @@ The most common configuration items defined at this level are: A list of arguments that you would normally pass to the scheduler when submitting to this partition (for example '`-p cpu`' for submitting to a Slurm partition called `cpu`). If supported by your scheduler, we recommend to _not_ export the submission environment - (for example by using '`--export=None`' with Slurm). This avoids test failures due to environment variables set + (for example by using '`--export=NONE`' with Slurm). This avoids test failures due to environment variables set in the submission environment that are passed down to submitted jobs. - [`prepare_cmds`](https://reframe-hpc.readthedocs.io/en/stable/config_reference.html#config.systems.partitions.prepare_cmds): - Commands to execute at the start of every job that runs a test, such as making the EESSI-installed version of Lmod available. + Commands to execute at the start of every job that runs a test, such as passing environment variables into jobs. - [`environs`](https://reframe-hpc.readthedocs.io/en/stable/config_reference.html#config.systems.partitions.environs): The names of optional additional environments (to be defined later in the configuration file via [`environments`](#environments)) ReFrame requires each test to run in a specific environment. The EESSI test suite automatically adds the available @@ -341,6 +333,20 @@ dictionary with required configuration options: set_common_required_config(site_configuration) ``` +If the EESSI modules are not available by default on the batch nodes, we can +add the necessary commands as `eessi_prepare_cmds` argument to make them +available in the batch job. If the system doesn't have an Lmod installation +by default on the batch nodes, the following commands will use the one from +EESSI: + +```python +eessi_prepare_cmds = [ + 'source /cvmfs/software.eessi.io/2025.06/init/lmod/bash', + 'module unload EESSI', +] +set_common_required_config(site_configuration, eessi_prepare_cmds=eessi_prepare_cmds) +``` + ### Auto-detection of processor information { #cpu-auto-detection } You can let ReFrame [auto-detect the processor information](https://reframe-hpc.readthedocs.io/en/stable/config_reference.html#config.systems.partitions.processor) for your system. From e17e4dd721fb0a0e61b4a25d307ee5a78fbba3e8 Mon Sep 17 00:00:00 2001 From: Samuel Moors Date: Tue, 8 Sep 2026 09:30:51 +0200 Subject: [PATCH 2/3] update --- docs/test-suite/ReFrame-configuration-file.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/test-suite/ReFrame-configuration-file.md b/docs/test-suite/ReFrame-configuration-file.md index e9344461b6..c5693cea1a 100644 --- a/docs/test-suite/ReFrame-configuration-file.md +++ b/docs/test-suite/ReFrame-configuration-file.md @@ -333,11 +333,10 @@ dictionary with required configuration options: set_common_required_config(site_configuration) ``` -If the EESSI modules are not available by default on the batch nodes, we can -add the necessary commands as `eessi_prepare_cmds` argument to make them -available in the batch job. If the system doesn't have an Lmod installation -by default on the batch nodes, the following commands will use the one from -EESSI: +If the EESSI modules are not available by default, we can add the necessary +commands as `eessi_prepare_cmds` argument to make them available. If the +system doesn't have an Lmod installation by default, the following commands +will use the one from EESSI: ```python eessi_prepare_cmds = [ From 3b91f7c395baf2dd8469eecf52dde5123c6fda95 Mon Sep 17 00:00:00 2001 From: Samuel Moors Date: Tue, 8 Sep 2026 10:23:51 +0200 Subject: [PATCH 3/3] update --- docs/test-suite/ReFrame-configuration-file.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/test-suite/ReFrame-configuration-file.md b/docs/test-suite/ReFrame-configuration-file.md index c5693cea1a..ea598acc92 100644 --- a/docs/test-suite/ReFrame-configuration-file.md +++ b/docs/test-suite/ReFrame-configuration-file.md @@ -334,9 +334,10 @@ set_common_required_config(site_configuration) ``` If the EESSI modules are not available by default, we can add the necessary -commands as `eessi_prepare_cmds` argument to make them available. If the -system doesn't have an Lmod installation by default, the following commands -will use the one from EESSI: +commands to [make them available](../using_eessi/setting_up_environment.md) +with the `eessi_prepare_cmds` keyword argument. If the system doesn't have an +Lmod installation by default, the following commands will use the one from +EESSI: ```python eessi_prepare_cmds = [