Help:HPCC Env Modules: Difference between revisions

From CSDMS
m (Add entries to cheat sheet table)
m (External link to Environment Modules page)
Line 3: Line 3:
Several software packages on the cluster require correct definition of certain environment variables. These variables establish the package's configuration and influence its behavior. For example, PATH and LD_LIBRARY_PATH specify the location of package binary files.
Several software packages on the cluster require correct definition of certain environment variables. These variables establish the package's configuration and influence its behavior. For example, PATH and LD_LIBRARY_PATH specify the location of package binary files.


Environment Modules is a tool to manage package environment variables.
[http://modules.sourceforge.net Environment Modules] is a tool to manage package environment variables.


With simple command line options, you can prepare the environment for any package available on the cluster. In the case of packages with multiple versions, there are options to switch between one version and another - defining and undefining variables as needed. If there is a conflict between two packages, module will alert you.
With simple command line options, you can prepare the environment for any package available on the cluster. In the case of packages with multiple versions, there are options to switch between one version and another - defining and undefining variables as needed. If there is a conflict between two packages, module will alert you.

Revision as of 20:41, 10 August 2009

Environment Modules

Several software packages on the cluster require correct definition of certain environment variables. These variables establish the package's configuration and influence its behavior. For example, PATH and LD_LIBRARY_PATH specify the location of package binary files.

Environment Modules is a tool to manage package environment variables.

With simple command line options, you can prepare the environment for any package available on the cluster. In the case of packages with multiple versions, there are options to switch between one version and another - defining and undefining variables as needed. If there is a conflict between two packages, module will alert you.

Cheat Sheet

Command Description
module avail List available modules
module load <module-name> Load module named <module-name>
module unload <module-name> Unload module named <module-name>
module whatis <module-name> Give description of module <module-name>
module list List modules that are loaded in your environment
module purge Unload all currently loaded modules from your environment
module display <module-name> Give the rules for module <module-name>