Environment modules

Environment modules are used to dynamically configure your environment. They modify $PATH and other environment variables to provide access to an application. Use the module command to manipulate modules.

Common module command options

module list list currently loaded modules
module avail list available modules
module load   <ModuleFile> load module file
module unload <ModuleFile> unload module file
module help list all command options

Examples

  • before using MATLAB R2018b, run the command
    module load matlab/2019a-research
  • to switch from MATLAB 2018b to 2019a-research, run these commands:
    module unload matlab/2018b-research
    module load matlab/matlab/2019a-research
    Or you could use:
    module swap matlab/2018b-research
        matlab/2019a-research

Applications that use modules

For an updated module list per partition you can use module-avail command described below.

How to list application modules using the module-avail command

Applications on the clusters are updated regularly, so the table above can be outdated from time to time. Also, a module command on the head node sees only the application modules installed on the head node. To get a list of applications currently available on the compute nodes in a partition, use the module-avail command.

  • list applications that use module files on a given partition
    • module-avail --partition=gpu_p100
  • list all the versions of a specific module
    • module-avail --partition=gpu_p100 --app=matlab
  • if no valid partition name is given, module-avail shows the list of valid partitions