Skip to content

Commit 54e7d28

Browse files
author
Vasileios Karakasis
committed
Update configuration documentation regarding modules
1 parent c01af53 commit 54e7d28

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

docs/config_reference.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1276,6 +1276,18 @@ It can either be a simple string or a JSON object with the following attributes:
12761276
A boolean value indicating whether this module refers to a module collection.
12771277
Module collections are treated differently from simple modules when loading.
12781278

1279+
.. js:attribute:: .path
1280+
1281+
:required: No
1282+
:default: ``null``
1283+
1284+
If the module is not present in the default ``MODULEPATH``, the module's location can be specified here.
1285+
ReFrame will make sure to set and restore the ``MODULEPATH`` accordingly for loading the module.
1286+
1287+
1288+
.. versionadded:: 3.5.0
1289+
1290+
12791291
.. seealso::
12801292

12811293
Module collections with `Environment Modules <https://modules.readthedocs.io/en/latest/MIGRATING.html#module-collection>`__ and `Lmod <https://lmod.readthedocs.io/en/latest/010_user.html#user-collections>`__.

reframe/schemas/config.json

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -390,15 +390,9 @@
390390
"save_log_files": {"type": "boolean"},
391391
"target_systems": {"$ref": "#/defs/system_ref"},
392392
"timestamp_dirs": {"type": "string"},
393-
"unload_modules": {
394-
"type": "array",
395-
"items": {"type": "string"}
396-
},
393+
"unload_modules": {"$ref": "#/defs/modules_list"},
397394
"use_login_shell": {"type": "boolean"},
398-
"user_modules": {
399-
"type": "array",
400-
"items": {"type": "string"}
401-
},
395+
"user_modules": {"$ref": "#/defs/modules_list"},
402396
"verbose": {"type": "number"}
403397
},
404398
"additionalProperties": false

0 commit comments

Comments
 (0)