Skip NavigationSkip to Content

Modules software environment

The module utility to manage nearly all application software on the ATRF cluster. There are three huge advantages of the module approach:

  1. ITOG can provide many different versions of a single software package, including a default version as well as several older and newer versions.
  2. Users can easily switch to different versions or installations without having to explicitly specify different paths.  With modules, environment variables such as PATH, LD_LIBRARY_PATH, and MANPATH are automatically managed. Users simply ?load? and ?unload? modules to control their environment.
  3. Users can control exactly which applications are in their environment.  By default, no applications outside of the operating system are in a user’s PATH.  Loading any particular module will add the specific application to the environment no other apps are loaded.

The module utility consists of two parts: the module command itself and the modulefiles on which it operates.

Module Command

module help

To get a usage list of module options type the following (the listing has been abbreviated to only those commands discussed on this page):

module help  

  Available Commands and Usage:

     +  add|load       modulefile [modulefile ...]
     +  rm|unload      modulefile [modulefile ...] 
     +  display|show   modulefile [modulefile ...] 
     +  avail          [modulefile [modulefile ...]]
     +  list      
     +  help           [modulefile [modulefile ...]]

To get help on a specific module use:

module help [modulefile]

This will provide a brief description of the module and list the versions available.

module list

module list

This lists all the modulefiles that are currently loaded into your environment.

module avail

module avail

This option lists all the modulefiles that are available to be loaded. You can also restrict this command to a single package; for example,

module avail amber

module display

module display modulefile

Use this command to see exactly what a given modulefile will do to your environment, such as what will be added to the PATH, LD_LIBRARY_PATH, etc., environment variables.

module load

module load modulefile1 [modulefile2] ...

This command adds one or more modulefiles to your current environment. It does so silently, unless there is a problem with a modulefile. If you load the generic name of a module, you will get the default version. To load a specific version, load the modulefile using its full specification.  For example,

module load amber

will do the same thing as

module load amber/amber12

module unload

module unload modulefile

This removes the listed module from the user’s current environment. Modulefiles can be removed in any order.  Note that this command will fail silently if the modulefile you specify is not already loaded.