The Environment Modules package provides for the dynamic modification of a user's environment via modulefiles. Loading a module for a necessary piece of software eliminates needs to specify environmental variables manually such as path to the executables via $PATH and path to the library via $LD_LIBRARY_PATH.
You can use Environment Modules by running the module command.
Module Commands
Command | Description |
---|---|
module avail | List available modules |
module list | List currently loaded modules |
module help MODULE | Help on MODULE |
module whatis MODULE | Brief description of MODULE |
module display MODULE | Display information about environment changes the MODULE will make if loaded |
module load MODULE | Load MODULE |
module unload MODULE | Unload MODULE and remove all changes it made to the environment |
module clear | Unloads all modules |
Examples
$ module avail
----- /usr/share/Modules/modulefiles
-----dot module-git module-info modules null use.own
----- /etc/modulefiles
-----mpi/openmpi-x86_64
----- /usr/local/share/Modules/modulefiles
-----boost/1.55.0 coq85pl3/8.5pl3 cudatoolkit/7.0 ocaml/4.02.3
----- /opt/share/Modules/modulefiles
-----rh/devtoolset/3
$ coqdoc --version
This is coqdoc version 8.5pl2, compiled on Aug 22 2016 9:25:3
$ module load coq85pl3/8.5pl3
$ coqdoc --version
This is coqdoc version 8.5pl3, compiled on Mar 7 2017 15:13:9
$ module list
Currently Loaded Modulefiles:
1) coq85pl3/8.5pl3
Helpful links
http://modules.sourceforge.net/