Overview

Supercomputing software environments are highly domain dependent, and to prevent conflicts while balancing ease of use, the software that your research needs will likely need to be loaded into the environment as a software module.

Listing Available Modules

The following command will list all available software modules.

module -l avail

Loading a module

The following command will load Aspect 2.3.0 installed with Spack

module load aspect-2.3.0-gcc-11.2.0

The following command will load Aspect 2.3.0 built manually on the Super Computer

module load aspect/2.3.0 

Listing Loaded Modules

To see a list of modules that are currently loaded use the following command.

module list

Unloading modules by name

To unload only a single module use the following command.

module unload aspect/2.3.0

Unloading all loaded modules

To unload all modules that are currently loaded run the following

module purge

Example

$ module avail aspect
------------------------------ /packages/modulefiles/apps ------------------------------
aspect/2.3.0  aspect/2.3.0-debug  aspect/2.4.0  aspect/2.4.0-debug  aspect/2.5.0-pre

----------------------------- /packages/modulefiles/spack ------------------------------
aspect-2.3.0-gcc-11.2.0
$ module load aspect/2.3.0
$ module list
Currently Loaded Modulefiles:
 1) dealii-9.3.3-gcc-11.2.0   2) openmpi-4.1.3-gcc-11.2.0   3) aspect/2.3.0
$ module purge
$ module list
No Modulefiles Currently Loaded.

Using Modules in SBATCH Job Scripts

Many sbatch scripts will include a module load command as part of the script.

Examples of this can be found here: Slurm - SBATCH Job Scripts