Zentrum für Datenverarbeitung (ZDV) (data center)

Description for the command "module"

The following table shows a choice of the most used options of the "module" command.

commanddescriptionexample

module avail <group>/[/<subgroup>]

or

module av <group>/[/<subgroup>]

shows a list of all modulesmodule avail compiler/phython
module load <group>/[/<subgroup>]loads the desired modulemodule load compiler/python/2.5.4
module listshows which modules are loaded module list
module show <modulename>shows changes when loading the module module show compiler/python/2.5.4
module helpshows the help text
module apropos <string>searches for a string in all loaded module filesmodule apropos python
module whatis <modulename>shows module descriptionmodule whatis compiler/python/2.5.4

How do I load software modules?

For loading a software module the following steps is recommended:

  1. Looking in which group or subgroup the software module is installed: 
module avail
  1. Optional you can filter the list when you know the group or subgroup: 
module avail <group>/[<subgroup>]
  1. Load the module
module load <group>/[<subgroup>]
module add <group>/[<subgroup>]
  1. Shows the loaded modules
module list
  1. Delete modules if they are not needed any more
module rm <group>/[<subgroup>]

Read more in the following Best Practise Guides: