Common Module Commands

module avail:

List all modules available to be loaded.

Use module avail <module name> lists all modules contains specific names.

[xtan@c001 ~]$ module avail py

---------------------------------------------------------------------------- /opt/ohpc/pub/moduledeps/gnu9-openmpi4 ----------------------------------------------------------------------------
   py3-mpi4py/3.0.3    py3-scipy/1.5.1

-------------------------------------------------------------------------------- /opt/ohpc/pub/moduledeps/gnu9 ---------------------------------------------------------------------------------
   py3-numpy/1.19.0

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

module whatis <module>

display information about a selected module.

[xtan@c001 ~]$ module whatis py3-mpi4py
py3-mpi4py/3.0.3    : Name: python3-mpi4py built with gnu9 compiler and openmpi4
py3-mpi4py/3.0.3    : Version: 3.0.3
py3-mpi4py/3.0.3    : Category: python module
py3-mpi4py/3.0.3    : Description: Python bindings for the Message Passing Interface (MPI) standard.
py3-mpi4py/3.0.3    : URL https://bitbucket.org/mpi4py/mpi4py

module spider <module name/version number>

Display detailed information about a specific version of the selected module.

[xtan@c001 ~]$ module spider py3-mpi4py/3.0.3

--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  py3-mpi4py: py3-mpi4py/3.0.3
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
    Description:
      Python bindings for the Message Passing Interface (MPI) standard.


    You will need to load all module(s) on any one of the lines below before the "py3-mpi4py/3.0.3" module is available to load.

      gnu9/9.3.0  mpich/3.3.2-ofi
      gnu9/9.3.0  mvapich2/2.3.4
      gnu9/9.3.0  openmpi4/4.0.5

    Help:

      This module loads the python3-mpi4py library built with the gnu9 compiler
      toolchain and the openmpi4 MPI library.

      Version 3.0.3

module list:

List modules loaded in the current environment.

[xtan@c001 ~]$ module list

Currently Loaded Modules:
  1) autotools   2) prun/2.1   3) gnu9/9.3.0   4) ucx/1.9.0   5) libfabric/1.11.2   6) openmpi4/4.0.5   7) ohpc

module load <module name/version number>

Load an available module to the current environment. It temporarily append the loaded executable file path to the $PATH environment variable.

[xtan@c001 ~]$ git --version
git version 2.27.0
[xtan@c001 ~]$ echo $PATH
/home/xtan/.local/bin:/home/xtan/bin:/opt/ohpc/pub/mpi/libfabric/1.11.2/bin:/opt/ohpc/pub/mpi/ucx-ohpc/1.9.0/bin:/opt/ohpc/pub/mpi/openmpi4-gnu9/4.0.5/bin:/opt/ohpc/pub/compiler/gcc/9.3.0/bin:/opt/ohpc/pub/utils/prun/2.1:/opt/ohpc/pub/utils/autotools/bin:/opt/ohpc/pub/bin:/usr/local/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/opt/dell/srvadmin/bin
[xtan@c001 ~]$ module load git/2.34.1
[xtan@c001 ~]$ git --version
git version 2.34.1
[xtan@c001 ~]$ echo $PATH
/opt/ohpc/pub/utils/git/2.34.1/bin:/home/xtan/.local/bin:/home/xtan/bin:/opt/ohpc/pub/mpi/libfabric/1.11.2/bin:/opt/ohpc/pub/mpi/ucx-ohpc/1.9.0/bin:/opt/ohpc/pub/mpi/openmpi4-gnu9/4.0.5/bin:/opt/ohpc/pub/compiler/gcc/9.3.0/bin:/opt/ohpc/pub/utils/prun/2.1:/opt/ohpc/pub/utils/autotools/bin:/opt/ohpc/pub/bin:/usr/local/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/opt/dell/srvadmin/bin

module unload <module>

Unload a module from the current environment. Since only 1 version of a selected module can be loaded at a time, unload command does not need a specific version number.

[xtan@c001 ~]$ git --version
git version 2.34.1
[xtan@c001 ~]$ module unload git
[xtan@c001 ~]$ git --version
git version 2.27.0



  • No labels