Accessing Supported Software

Posted on: August 3, 2018

Managing Your Environment Using the Modules Command

The module command is a user interface to the Modules package. The Modules package provides for the dynamic modification of the user’s environment via modulefiles (a modulefile contains the information needed to configure the shell for an application). Modules are independent of the user’s shell, so both tcsh and bash users can use the same commands to change the environment.

 

Useful Module Commands

Command
Description
module avail lists all available modules
module list lists currently loaded modules
module help modulefile help on module modulefile
module display modulefile Display information about modulefile
module load modulefile load modulefile into the current shell environment
module unload modulefile remove modulefile from the current shell environment
module swap modulefile1 modulefile2 unload modulefile1 and load modulefile2

 

To include particular software in the environment for all new shells: edit your shell configuration file ( 

$HOME/.bashrc

  for bash users

$HOME/.cshrc

 and for tcsh users) by adding the module commands to load the software that you want to be a part of your environment. After saving your changes, you can source your shell configuration file or log out and then log back in for the changes to take effect.

Order Is Important

With each module load, the changes are prepended to your current environment paths. When a module name is followed by (default), that is the version that will be loaded you don’t specify a version. For instance, 

module load gdal

 will load gdal version 1.11.3.


Additional Resources

Modules SourceForge » Home page for the Environment Modules open-source project.

Module Man Page »

Modulefile Man Page »