Purpose
Lucia users are provided with many pre-installed software packages and scientific libraries. To facilitate this, environment management tools are used to handle necessary changes to the users shell and Lmod is used as the modules management tool.
Useful links
📚 For further information:
- Overall documentation: https://lmod.readthedocs.io/en/latest/
- GitHub: https://github.com/TACC/Lmod
- SourceForge: https://lmod.sf.net
- Lmod Mailing list: https://sourceforge.net/projects/lmod/lists/lmod-users
Useful Lmod commands
| Command | Description |
|---|---|
module avail |
Shows the currently available modules |
module help <modulename> |
Shows help information about <modulename> |
module show <modulename> |
Shows the environment changes made by the <modulename> modulefile |
module spider <string> |
Searches all possible modules according to <string> |
module whatis <modulename> |
Displays some descriptive information about the <modulename> module |
module load <modulename> |
Loads the software module <modulename> in your environment |
module unload <modulename> |
Unloads the software module <modulename> from your environment |
module use <path> |
Adds <path> to the modulefile search cache and MODULESPATH |
module purge |
Unloads all previously loaded modules |
Tip
Some modules may be "sticky": these modules cannot be unloaded once loaded. They can be identified with the status (S) when the output of the module avail is displayed. Use the option --force to unload them (eg. module --force purge or module --force unload <modulename>)
The ml acronym
Users having difficulties to properly type the module command (which could become moduel, modue,...) will enjoy the ml command. The table below summarizes its usage.
| Command | Equivalent module command |
|---|---|
ml |
module list |
ml <modulename> |
module load <modulename> |
ml -<modulename> |
module unload <modulename> |
ml <modulename1> -<modulename2> |
module unload <modulename2>; module load <modulename1> |
ml avail |
module avail |
ml spider |
module spider |
ml show <modulename> |
module show <modulename> |
ml --force purge |
module --force purge |
Info
Lmod is provided by the HPE Cray Programming Environment software stack. Its version is slightly older than the most recent one that can be found on the project github. As a consequence, some information provided on the readthedocs.io of the project may not be relevant to the version available on Lucia.