We use Lua based modules (Lmod) for packaging software environments on our systems including compilers, MPI, CUDA, debuggers, performance tools or math libraries.
Basic Lmod Commands
The table below summarizes the most common Lmod module commands. Full documentation for Lmod modules can be found at: lmod.readthedocs.io/en/latest/010_user.html.
Module Command | Shortcut | Description |
|---|---|---|
module avail | ml avail | List available modules |
module -d avail | ml -d avail | List only default modules |
module overview | module ov | ml ov | List available modules by short names with number of versions. |
module list | ml | Show modules currently loaded |
module load package | ml package ml load package | Load a selected module |
module unload package | ml unload package ml -package | Unload a previously loaded module |
module swap package1 package2 | ml swap package1 package2 | Unload package1 and load package2 |
module purge | ml purge | Unload all loaded modules |
module reset | ml reset | Reset loaded modules to system defaults |
module display package | n/a | Display the contents of a selected module |
module spider | ml spider | List all modules (not just available ones) |
module spider package | ml spider package | Display description of a selected module |
module keyword key | ml keyword key | Search for available modules by keyword |
module, module help | ml help | Display help, usage information for modules |
module use path | ml use path | Add path to the MODULPATH search path |
Gateway Modules
To minimize the output of module avail, we use so called gateway modules, which change the search path for module files. Most of the software we provide is installed using EasyBuild. Therefore, we follow the naming of EasyBuild for the categories. The initial module avail output will look like this:
Loading for example the gateway module chem changes the Lmod search path and you will see now all available software packages from the category chem:
Central Spider Cache
We provide a central spider cache which is updated each 5 minutes to accelerate the speed of module avail and module spider
Searching Modules
We provide a script to ease searching of modules.