The Lmod Modules System¶

PEARL uses the Lmod environment modules system to make pre-compiled software available to you.

Note

The following module paths are automatically added to your environment at logon. These give you access to optimised, pre-compiled software including the system’s default Singularity build.

/apps/modulefiles/eb/all:/apps/modulefiles/core

To view all the software that is available to you:

$ module avail

To list the currently loaded modules:

$ module list

To load software provided by a module:

$ module load [module_name]

To unload a module:

$ module unload [module_name]

To substitute one module for another:

$ module swap [module1_name] [module2_name]

To unload all currently loaded modules and revert to the system default state:

$ module restore

Lmod also has a tool called ml which provides the same functionality as the full module command but in a shorter, more convenient format. For instance, listing the currently loaded modules becomes simply:

$ ml

Showing all available modules can be done with:

$ ml av

You can load a module using:

$ ml [module_name]

You can unload a module with:

$ ml –[module_name]