Table of Contents
- Available Modules
- Loading a Module
- Unloading a Module
- Switch Module Files
- View loaded Modules
- Reload all Modules
- Module Collections
- Load Module at log in
- Further uses
Available Modules
To view all available modules run:
module avail
Loading a Module
To load a module to your current environment run:
module load module_name
or
module add module_name
Note: Loaded modules are available on your path for your current session. So jobs queued with srun will have access to them. Jobs queued with sbatch will need to load the modules again in order to have access to them
Unloading a Module
To unload a module from your environment runL
module unload module_name
or
module rm module_name
Switch Module files
To switch module_file1 with module_file2, run:
module switch module_file1 module_file2
View Loaded Modules
To view the modules currently loaded, run:
module list
Reload all Modules
To reload the loaded files and reset the PATH run:
module reload
or
module refresh
Module Collections
To save the current set of loaded modules to a collection to be used later, run:
module save filename
To restore modules from the saved collection, run:
module restore collection_name
To see all available collections, run:
module saveshow
Load Modules at Log in
You can set up your environment such that modules are automatically loaded when you log in everytime. To add module to the initial list of loaded modules, run:
module initadd module_name
Further Uses
For further options for the module command, run:
module help