Skip to content

Commit e3b8d37

Browse files
committed
Describe MODULES_CMD env var use to search module tool
When using EnvironmentModules as module tool, the modulecmd.tcl binary is now also searched with "$MODULES_CMD" environment variable, like done for Lmod with "$LMOD_CMD".
1 parent a06a058 commit e3b8d37

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

docs/configuration.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,9 @@ output of `type -f module` (in a `bash` shell), or `alias module` (in a `tcsh` s
620620

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

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

docs/installation.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -356,12 +356,16 @@ Supported module tools:
356356
the `module` function; for example, using `type module` or `type -f module`.
357357

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

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

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

366370
Additional notes:
367371

0 commit comments

Comments
 (0)