Scottb at 00:16, 3 March 2007

2007-03-03T00:16:17Z

← Older revision		Revision as of 00:16, 3 March 2007
Line 67:		Line 67:
	To find out what a module is:		To find out what a module is:

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

	To see how a module affects your environment:		To see how a module affects your environment:

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

	To load or unload a module:		To load or unload a module:

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

	To view a list of loaded modules:		To view a list of loaded modules:

Scottb at 00:14, 3 March 2007

2007-03-03T00:14:49Z

New page

= Modules HOWTO =

== Intro ==

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

Modules 3.2.3 is installed in /usr/local/packages/Modules on Neuronic, Optix, and the linux-based IBMs (p690, p655-1, p655-2, p655-3, and iconic blades).

== 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 3.2.3
setenv MODULESHOME /usr/local/packages/Modules/$MODULE_VERSION
if (-e $MODULESHOME/init/tcsh) source $MODULESHOME/init/tcsh
setenv MODULEPATH $MODULESHOME/modulefiles:$MODULEPATH
</pre>

'''bash'''

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

== Additional set up on IBMs ==

Absoft Modules (version 3.1.6) are already enabled on the IBMs by default. The latest install (version 3.2.3) is currently set up to use the Absoft Modules as well as it's own, but to use this version, you must disable the Absoft modules. This can be done by adding the following lines to your startup scripts:

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

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

== 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</pre>

<pre>man module</pre>

Modules HOWTO - Revision history

Scottb at 00:16, 3 March 2007

Scottb at 00:14, 3 March 2007