There are many software packages installed on the HPC supercomputer that are available through the software modules system.
New packages are added regularlySupercomputing 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.
As of July 21, 2022, there were 1,380 software modules on Agave (https://links.asu.edu/modules)! New packages are added regularly, typically at the request of researchers.
This page documents how to use the module system as to configure Agave’s supercomputing environment to properly execute your computational research workflows.
Table of Contents |
---|
Info |
---|
Modules that install into/through python or anaconda are not managed through the software modules. To see if we have a conda environment for a python program load an anaconda module and list conda environments e.g.
|
...
Listing available modules
The following command will list the software modules that are available on Agave:
Code Block |
---|
module -l avail |
Agave’s modules may also be perused online here: https://links.asu.edu/modules
...
Loading a module
The following command will load the module for gcc/4.9.2
Code Block |
---|
module load gcc/4.9.2 |
...
Full versions are required
In the past, users could load a module using a short name, without a version number, as follows:
...
The full name of a module including its version must be used when loading modules.
...
Listing Loaded Modules
The following command will list the modules that are currently loaded:
Code Block |
---|
module list |
...
Purging Loaded Modules
To clear out the modules that are currently loaded, perhaps because you want to load others, use the following command:
Code Block |
---|
module purge |
...
Using Modules in SBATCH scripts
Many sbatch scripts will include a module load command as part of the scriptScheduled computational job scripts must specify the software environment that they need in order to execute properly. This increases the portability and consistency of computational research workflows (by providing effective documentation and definition of the necessary software environment to have the work run successfully).
On Agave, software modules are loaded with the module load <software>/<version>
command pattern as shown above.
An example of this can be found here: Creating SBATCH scripts
Info |
---|
Recall that on Agave: computational work must be scheduled through the use of batch scripts that are typically passed to the shell command, |