modules: use depends-on to autoload module with Lmod on Tcl #38347
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spackbot-app
bot
added
core
alalazo
reviewed
Jun 14, 2023
alalazo
previously approved these changes
Jun 14, 2023
alalazo
reviewed
Jun 14, 2023
| @@ -26,9 +26,15 @@ proc ModulesHelp { } { | |||
| {% endblock %} | |||
|
|
|||
| {% block autoloads %} | |||
| if {![info exists ::env(LMOD_VERSION_MAJOR)]} { | |||
There was a problem hiding this comment.
On a second look, wouldn't this be creating an empty if/else statement if no autoload modules are present?
There was a problem hiding this comment.
Good catch! I need to check if there is something to autoload prior adding this if/else statement.
There was a problem hiding this comment.
I have reworked template to check if there are elements to autoload with {% if autoload|length > 0 %} condition.
I have also updated tests to add assertion checking if if {![info exists ::env(LMOD_VERSION_MAJOR)]} { condition is there or not.
Update Tcl modulefile template to use the `depends-on` command to autoload modules if Lmod is the current module tool. Autoloading modules with `module load` command in Tcl modulefile does not work well for Lmod at some extend. An attempt to unload then load designated module is performed each time such command is encountered. It may lead to a load storm that may not end correctly with large number of module dependencies. `depends-on` command should be used for Lmod instead of `module load`, as it checks if module is already loaded, and does not attempt to reload this module. Lua modulefile template already uses `depends_on` command to autoload dependencies. Thus it is already considered that to use Lmod with Spack, it must support `depends_on` command (version 7.6+). Environment Modules copes well with `module load` command to autoload dependencies (version 3.2+). `depends-on` command is supported starting version 5.1 (as an alias of `prereq-all` command) which was relased last year. This change introduces a test to determine if current module tool that evaluates modulefile is Lmod. If so, autoload dependencies are defined with `depends-on` command. Otherwise `module load` command is used. Test is based on `LMOD_VERSION_MAJOR` environment variable, which is set by Lmod starting version 5.1. Fixes spack#36764
xdelaruelle
force-pushed
the
lmod_autoload_with_depends_on
branch
from
f920569 to
1210bb2
Compare
alalazo
approved these changes
Jun 14, 2023
|
Thanks! |
alalazo
pushed a commit
that referenced
this pull request
Jun 30, 2023
Update Tcl modulefile template to use the `depends-on` command to autoload modules if Lmod is the current module tool. Autoloading modules with `module load` command in Tcl modulefile does not work well for Lmod at some extend. An attempt to unload then load designated module is performed each time such command is encountered. It may lead to a load storm that may not end correctly with large number of module dependencies. `depends-on` command should be used for Lmod instead of `module load`, as it checks if module is already loaded, and does not attempt to reload this module. Lua modulefile template already uses `depends_on` command to autoload dependencies. Thus it is already considered that to use Lmod with Spack, it must support `depends_on` command (version 7.6+). Environment Modules copes well with `module load` command to autoload dependencies (version 3.2+). `depends-on` command is supported starting version 5.1 (as an alias of `prereq-all` command) which was relased last year. This change introduces a test to determine if current module tool that evaluates modulefile is Lmod. If so, autoload dependencies are defined with `depends-on` command. Otherwise `module load` command is used. Test is based on `LMOD_VERSION_MAJOR` environment variable, which is set by Lmod starting version 5.1. Fixes #36764
alalazo
pushed a commit
that referenced
this pull request
Jul 7, 2023
Update Tcl modulefile template to use the `depends-on` command to autoload modules if Lmod is the current module tool. Autoloading modules with `module load` command in Tcl modulefile does not work well for Lmod at some extend. An attempt to unload then load designated module is performed each time such command is encountered. It may lead to a load storm that may not end correctly with large number of module dependencies. `depends-on` command should be used for Lmod instead of `module load`, as it checks if module is already loaded, and does not attempt to reload this module. Lua modulefile template already uses `depends_on` command to autoload dependencies. Thus it is already considered that to use Lmod with Spack, it must support `depends_on` command (version 7.6+). Environment Modules copes well with `module load` command to autoload dependencies (version 3.2+). `depends-on` command is supported starting version 5.1 (as an alias of `prereq-all` command) which was relased last year. This change introduces a test to determine if current module tool that evaluates modulefile is Lmod. If so, autoload dependencies are defined with `depends-on` command. Otherwise `module load` command is used. Test is based on `LMOD_VERSION_MAJOR` environment variable, which is set by Lmod starting version 5.1. Fixes #36764
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update Tcl modulefile template to use the
depends-oncommand to autoload modules if Lmod is the current module tool.Autoloading modules with
module loadcommand in Tcl modulefile does not work well for Lmod at some extend. An attempt to unload then load designated module is performed each time such command is encountered. It may lead to a load storm that may not end correctly with large number of module dependencies.depends-oncommand should be used for Lmod instead ofmodule load, as it checks if module is already loaded, and does not attempt to reload this module.Lua modulefile template already uses
depends_oncommand to autoload dependencies. Thus it is already considered that to use Lmod with Spack, it must supportdepends_oncommand (version 7.6+).Environment Modules copes well with
module loadcommand to autoload dependencies (version 3.2+).depends-oncommand is supported starting version 5.1 (as an alias ofprereq-allcommand) which was relased last year.This change introduces a test to determine if current module tool that evaluates modulefile is Lmod. If so, autoload dependencies are defined with
depends-oncommand. Otherwisemodule loadcommand is used.Test is based on
LMOD_VERSION_MAJORenvironment variable, which is set by Lmod starting version 5.1.Fixes #36764