The module utility helps you identify software that is available on the system and then load compatible packages. It manages complex combinations of paths, variables, and dependencies so you can compile and run jobs efficiently and make the most of your allocation.
Some modules are loaded by default. To see which modules those are, run module list when you log in. Depending on the work you need to do, you can load additional modules or different modules, or you can create and save multiple customized environments as described below.
Following are descriptions of commonly used module commands.
module av – Show which modules are available for use with the currently loaded compiler.
module help – List options and subcommands for the module utility; or specify a modulefile by name for help with an individual module.
module list – List the modules that are loaded.
module load – Load the default version of a software package, or load a specified version.
module purge – Unload all modules. Some users include this command in a batch script, followed by a sequence of module load commands to establish a customized environment for the job being submitted.
module spider – List all modules that exist on the system. This does not give you information on module dependencies or tell you which modules can be loaded without conflicts at that point. Output from this command is published on these web pages daily for easy reference when you are not logged in: Cheyenne and Casper.
module swap – Unload one module and load a different one. Example:
module unload – Unload the specified software package.
module whatis – Get a short description of a module.
If you have created your own environment or want to have multiple collections of modules for various tasks, you can save those customized environments for easy re-use.
To save a customized environment as your default environment, load the modules that you want to use, then simply run module save or module s.
If you plan to set up additional custom environments for other needs, give each collection of modules a unique name.
To see a list of your customized, saved environments, use module savelist.
To use one of the custom environments from that list, use module restore, or module r, followed by the name.
To see which modules you've saved in a custom environment, use module describe as shown.
To remove a customized environment that you have saved:
To revise a customized environment:
The previously saved environment will be renamed automatically with the addition of a tilde (~). In the example just above, the previously saved environment would be renamed to myenvironment~.