Cluster: Software available using “module”; how to use “module”


To ease use of software and to support different versions of software, the Duke Compute Cluster uses module.

From the Modules project: 

Typically users initialize their environment when they log in by setting environment information for every application they will reference during the session. The Environment Modules package is a tool that simplify shell initialization and lets users easily modify their environment during the session with modulefiles.

Each modulefile contains the information needed to configure the shell for an application. Once the Modules package is initialized, the environment can be modified on a per-module basis using the module command which interprets modulefiles. Typically modulefiles instruct the module command to alter or set shell environment variables such as PATH, MANPATH, etc. modulefiles may be shared by many users on a system and users may have their own collection to supplement or replace the shared modulefiles.

Modules can be loaded and unloaded dynamically and atomically, in an clean fashion. All popular shells are supported, including bash, ksh, zsh, sh, csh, tcsh, as well as some scripting languages such as perl and python.

Modules are useful in managing different versions of applications. Modules can also be bundled into metamodules that will load an entire suite of different applications.

The Modules project web page is at http://modules.sourceforge.net/ and the NERSC (National Energy Research Scientific Computing Center) website has good documentation as well: https://www.nersc.gov/users/software/nersc-user-environment/modules/.

To get information on software that is currently available in modules, enter

module avail

at the command line. Additional information on how to use module is available by entering

man module

at the command line on a DCC login node.

The module command can be used in SLURM submission scripts to set paths to software that you want to use.

If you want help with module or want to have software packages added in a modulefile, contact rescomputing@duke.edu.