Description for the command "module"
The following table shows a choice of the most used options of the "module" command.
| command | description | example |
|---|---|---|
module avail <group>/[/<subgroup>] or module av <group>/[/<subgroup>] | shows a list of all modules | module avail compiler/phython |
| module load <group>/[/<subgroup>] | loads the desired module | module load compiler/python/2.5.4 |
| module list | shows which modules are loaded | module list |
| module show <modulename> | shows changes when loading the module | module show compiler/python/2.5.4 |
| module help | shows the help text | |
| module apropos <string> | searches for a string in all loaded module files | module apropos python |
| module whatis <modulename> | shows module description | module whatis compiler/python/2.5.4 |
How do I load software modules?
For loading a software module the following steps is recommended:
- Looking in which group or subgroup the software module is installed:
module avail
- Optional you can filter the list when you know the group or subgroup:
module avail <group>/[<subgroup>]
- Load the module
module load <group>/[<subgroup>]
module add <group>/[<subgroup>]
- Shows the loaded modules
module list
- Delete modules if they are not needed any more
module rm <group>/[<subgroup>]
Read more in the following Best Practise Guides: