Ympäristömoduulit

Kun käytössä on useita samaa tarkoitusta palvelevia ohjelmia (esimerkiksi SMTP-palvelimia, kuten sendmail, exim ja postfix; tai tulostuspalvelimia, kuten lprng ja cups), on tavallista käyttää vaihtoehtoisia tapoja (Alternatives). Vaihtoehtoiset tavat tarjoavat selkeän tavan asentaa useita samaa tarkoitusta palvelevia ohjelmistoja samanaikaisesti ja saada komennot, kuten mail ja lpr, osoittamaan haluttuihin versioihin.

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 multiple implementations of a solution has been developed: environment modules and Lmod. Fedora currently makes use of this primarily for handling switching between different MPI implementations.

Ympäristömoduulit ovat hyödyllisiä myös tilanteissa, joissa paketti haluaa asentaa binääritiedostoja, jotka käyttävät yleisiä nimiä ja saattavat aiheuttaa ristiriitoja tiedostojen kanssa /usr/bin-hakemistossa tai muuten saastuttaa ne. Käyttäjien on tällöin ladattava ympäristömoduuli ennen kuin näitä ohjelmia voidaan käyttää.

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

The upstream documentation for the module command is available here or with man module.

To install an environment module, place a module file into %{_modulesdir}, which should evaluate to /usr/share/modulefiles. This macro is available in Fedora and EPEL 7+. The directory /usr/share/Modules/modulefiles is to be used only for internal modules of environment-modules. /etc/modulefiles is available to local system administrator use.

The module files are plain text with optional tcl syntax, for instance an environment module for 64-bit OpenMPI mpi/openmpi-x86_64:

The module file begins with the magic cookie +#%Module +, where is the version of the module file used. The current version is 1.0.

The above commands prepends the path with the bindir of the 64-bit OpenMPI (compiled with GCC) and adds the relevant library path. Then it sets various environment variables.

It is also possible to set CFLAGS and LDFLAGS with the above manner, but in the case of MPI compilers it is not necessary since the compilers are invoked with the mpicc, mpicxx, mpif77 and mpif90 wrappers that already contain the necessary include and library paths. Also, in the case of development packages an override of CFLAGS and/or LDFLAGS is not sane, as it may cause trouble in building RPMs as it overrides %{optflags}.

The upstream documentation for module files is available here or with man modulefile.

Switching between the environment-modules and Lmod implementations is done via alternatives. The shell init scripts /etc/profile.d/modules.\{csh,sh} are links to /etc/alternatives/modules.\{csh.sh} and can be manipulated with the alternatives command.

Lmod is an environment modules implementation written in Lua, and can make use of module files written in Lua as well as Tcl. Such files have a ".lua" extensions. However, such files must not be installed /usr/share/modulefiles so as to not cause issues when the environment-modules package is in use. Instead install into %{_datadir}/lmod/lmod/modulefiles/Core.