Useful Module Commands¶
The module command has a variety of subcommands, outlined in the table below.
You may shorten the command to ml, but the shortened command may require
specialized syntax.
| Command | Description |
|---|---|
module avail |
List available software. |
module spider <module> |
Searches for a particular software. |
module load <module> |
Load a module to use the software. |
module unload <module> |
Remove or unload a module |
module purge |
Remove all modules. |
module save <name> |
Save the state of all loaded modules |
module restore <name> |
Restore a state of saved modules. |
module help |
Find information about additional |
For more information, refer to the Lmod user guide
Loading modules automatically¶
Do not load modules automatically
We advise against loading modules automatically in your .bashrc
Instead we recommend that you load modules only when required, for example in your job scripts.
Sticky modules¶
Several modules are loaded by default for you when you login. These are also known as "sticky" modules and are maintained by CCR. You should not unload these modules as they provide a standard set of configurations for CCR's software environment.
For reference these include:
| Module | Description |
|---|---|
| ccrenv | environment variables for global scratch, local scratch and util |
| gentoo | Sets up environment variables for CCR's compatibility layer |
| ccrsoft | CCR's Standard Software Environment |