Skip to main content

Using modules

Modules are configuration files that modify your software environment. A module file contains the information needed to make an application or library available in the user's session.

Modules are managed by Lmod 7.4 (https://www.tacc.utexas.edu/research-development/tacc-projects/lmod).

List installed modules​

The command module available or module av or ml av lists the modules currently available.

[dpena@vm-gce17 gce17]$ module available

--------------------------------------------- /opt/modulefiles/compilers ----------------------------------------------
   gcc/4.9.4 (D)    gcc/5.4.0    gcc/6.3.0    intel/2017.1.132    pgi/16.10

------------------------------------------------ /opt/modulefiles/mpi -------------------------------------------------
   intelmpi/2017.1.132    openmpi/2.1.0/gcc-4.9.4 (D)    openmpi/2.1.0/intel17    openmpi/2.1.0/pgi-16

--------------------------------------------- /opt/modulefiles/libraries ----------------------------------------------
   hypre/2.10.0b    metis/4.0.3    mkl/2017.1.132

------------------------------------------------ /opt/modulefiles/apps ------------------------------------------------
   quantum-espresso/5.3.0/intel17    quantum-espresso/6.0/intel17    vasp/5.4.1/intel17

----------------------------------------------- /opt/modulefiles/tools ------------------------------------------------
   advisor/2017.1.1.486553    idb/2017    inspector/2017.1.1.484836    vtune-amp/2017.1.0.486011

  Where:
   D:  Default Module

Use "module spider" to find all possible modules.
Use "module keyword key1 key2 ..." to search for modules matching any of the keys (key1, key2).

Module operations​

Load a module​

To load a module, for example GCC version 6.3.0, run:

module load gcc/6.3.0

To load the Intel compiler, Intel MPI libraries and MKL:

module load intel intelmpi mkl
Tip

You can add module load commands to your ~/.bashrc. Modules will then be loaded automatically at login.

Unload a module​

To remove a module from your environment, e.g. gcc/6.3.0, run:

module unload gcc/6.3.0

Unload all modules​

To unload all modules from your environment run:

module purge

List loaded modules​

To list currently loaded modules run module list:

[dpena@vm-gce17 gce17]$ module list

Currently Loaded Modules:
  1) intel/2017.1.132      3) mkl/2017.1.132   5) hypre/2.10.0b
  2) intelmpi/2017.1.132   4) metis/4.0.3      6) advisor/2017.1.1.486553