Nic-systems: Created page with "The Modules package provides for the dynamic modification of the user's environment via modulefiles. Modules 3.2.10 is installed in /usr/local/packages/Modules (or possibly /..."

2020-02-04T02:16:14Z

Created page with "The Modules package provides for the dynamic modification of the user's environment via modulefiles. Modules 3.2.10 is installed in /usr/local/packages/Modules (or possibly /..."

New page

The Modules package provides for the dynamic modification of the user's environment via modulefiles.

Modules 3.2.10 is installed in /usr/local/packages/Modules (or possibly /packages) on the compute/development nodes. In case the Modules version is ever updated, the alias 'current' will always point to the latest version, and may be used instead of a version number.

== Set Up ==

To use Modules on these platforms, add the following lines to your login scripts:

'''tcsh'''

If you use tcsh as your login shell, add these lines to your .cshrc or .tcshrc file:
<pre>
setenv MODULE_VERSION current
setenv MODULESHOME /usr/local/packages/Modules/$MODULE_VERSION
unsetenv MODULEPATH
if (-e $MODULESHOME/init/tcsh) source $MODULESHOME/init/tcsh
</pre>

'''bash'''

If you use bash as your login shell, add these lines to your .bash_profile:
<pre>
export MODULE_VERSION=current
export MODULESHOME=/usr/local/packages/Modules/$MODULE_VERSION
export MODULEPATH=""
test -s $MODULESHOME/init/bash && . $MODULESHOME/init/bash
</pre>

Note: Some platforms already have an older, built-in version of Modules installed and enabled by default, which can interfere with the proper function of the current version (3.2.3). The current version is set up to use both the built-in modules as well as it's own. To ensure proper behavior, the MODULEPATH variable is deliberately unset, and then properly initialized using the Modules init scripts.

== Additional set up on IBMs ==

Absoft Modules (version 3.1.6) are already enabled on the IBMs by default. To use the latest install (3.2.3), which includes all of the Absoft modulefiles and more, you must disable the Absoft modules. This can be done by adding the following line to your startup scripts:

'''tcsh'''
<pre>
setenv MODULE_ABSOFT disabled
</pre>

'''bash'''
<pre>
export MODULE_ABSOFT=disabled
</pre>

This line should be placed somewhere before the "if" (csh) or "test" (bash) line that sources the Modules init script.

== Using Modules ==

Once the Module script is sourced (see above), invoke the "module" command to use modules.

'''Examples'''

To get usage info on modules:

<pre>module help</pre>

To list available modules:

<pre>module avail</pre>

To list available mpi modules:

<pre>module avail mpi</pre>

To find out what a module is:

<pre>module whatis {module}</pre>

To see how a module affects your environment:

<pre>module show {module}</pre>

To load or unload a module:

<pre>module load/unload {module}</pre>

To view a list of loaded modules:

<pre>module list</pre>

For more information on using modules, load the "modules" module, then view the man page module:

<pre>module load modules
man module</pre>

Software:Modules - Revision history

Nic-systems: Created page with "The Modules package provides for the dynamic modification of the user's environment via modulefiles. Modules 3.2.10 is installed in /usr/local/packages/Modules (or possibly /..."