From Fedora Project Wiki
Line 12: Line 12:
== Using environment modules ==
== Using environment modules ==


To create an environment module, place a module file into <code>/etc/modulefiles/</code>. To see what modules are available, run <code>$ module avail</code>
To see what modules are available, run <code>$ module avail</code>. To load a module run e.g. <code>$ module load openmpi-i386</code>. To unload a module, run e.g. <code>$module unload openmpi-i386</code>.




The module files are plain text with a tcl syntax, for instance the openmpi module <code>openmpi-i386</code> is at the moment:
== Creating environment modules ==
 
To create an environment module, place a module file into <code>/etc/modulefiles/</code>. The module files are plain text with a tcl syntax, for instance the openmpi module <code>openmpi-i386</code> is at the moment:


<pre>#  OpenMPI module for use with 'environment-modules' package:
<pre>#  OpenMPI module for use with 'environment-modules' package:

Revision as of 08:19, 22 July 2009

Packaging Draft / Use of environment modules


Introduction

When one has multiple programs serving the same purpose (for instance SMTP servers such as sendmail, exim and postfix; or print servers such as lprng and cups), it is usual to wrap these using alternatives. Alternatives provides a clean way to have many types of software serving the same purpose installed at the same time and have the commands such as mail and lpr point to the wanted versions.


However, when there are multiple variants that each serve the needs of some user and thus must be available simultaneously by users, the alternatives system simply isn't enough since it is system-wide. This has been reality on supercomputers and clusters for eons, and a solution has been developed: environment modules.


Using environment modules

To see what modules are available, run $ module avail. To load a module run e.g. $ module load openmpi-i386. To unload a module, run e.g. $module unload openmpi-i386.


Creating environment modules

To create an environment module, place a module file into /etc/modulefiles/. The module files are plain text with a tcl syntax, for instance the openmpi module openmpi-i386 is at the moment:

#  OpenMPI module for use with 'environment-modules' package:
# 
prepend-path            PATH            /usr/lib/openmpi/1.3.3-gcc/bin
prepend-path            LD_LIBRARY_PATH /usr/lib/openmpi/1.3.3-gcc/lib
setenv                 CFLAGS          "-I/usr/lib/openmpi/1.3.3-gcc/include -m32"
setenv                 LDFLAGS         "-L/usr/lib/openmpi/1.3.3-gcc/lib -lmpi"
setenv                  MPI_BIN         /usr/lib/openmpi/1.3.3-gcc/bin
setenv                  MPI_LIB         /usr/lib/openmpi/1.3.3-gcc/lib
setenv                  MPI_HOME        /usr/lib/openmpi/1.3.3-gcc

The above prepends the path with the bindir of the 32-bit OpenMPI 1.3.3 compiled with GCC and adds the relevant library path. Then it sets five environment variables.

In the case of MPI compilers, no CFLAGS or LDFLAGS should however be set, since the compilers should be invoked with the mpicc, mpicxx, mpif77 and mpif90 wrappers that already contain the necessary include and library paths.