Skip to content

Commit

Permalink
Merge pull request #225 from xdelaruelle/MODULES_CMD
Browse files Browse the repository at this point in the history
Describe MODULES_CMD env var use to search module tool
  • Loading branch information
ocaisa authored Feb 23, 2024
2 parents 39ffaa0 + e3b8d37 commit 3162174
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,9 @@ output of `type -f module` (in a `bash` shell), or `alias module` (in a `tcsh` s

The actual module command (i.e., `modulecmd`, `modulecmd.tcl`,
`lmod`, ...) must be available via `$PATH` (which is not standard), except when using Lmod
(in that case the `lmod` binary can also be located via `$LMOD_CMD`).
(in that case the `lmod` binary can also be located via `$LMOD_CMD`) or when using
Environment Modules (in that case the `modulecmd.tcl` binary can also be located via
`$MODULES_CMD`).

For example, to indicate that EasyBuild should be using `Lmod` as modules tool:

Expand Down
6 changes: 5 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,12 +356,16 @@ Supported module tools:
the `module` function; for example, using `type module` or `type -f module`.

!!! note
For Lmod specifically, EasyBuild will try to fall back to finding the `lmod` binary via the `$LMOD_CMD`
For Lmod, EasyBuild will try to fall back to finding the `lmod` binary via the `$LMOD_CMD`
environment variable, in case `lmod` is not available in `$PATH`.

In EasyBuild versions *prior* to 2.1.1, the path specified by `$LMOD_CMD` was (erroneously) preferred over the
(first) `lmod` binary available via `$PATH`.

For modern Tcl-only environment modules (version >= 4.0.0), EasyBuild will try to fall back to finding the
`modulecmd.tcl` binary via the `$MODULES_CMD` environment variable, in case `modulecmd.tcl` is not available
in `$PATH`.


Additional notes:

Expand Down

0 comments on commit 3162174

Please sign in to comment.