Calcul :

Messagerie :

Messagerie du personnel

Messagerie des étudiants

Demande d'entrée dans le SI

Listes diffusion

Création de liste

Documentation

Accueil > Site Public > Calcul

Environnement logiciel : modules

Publié le 21 février 2012, mis a jour le 4 décembre 2017

Export en PDF :

Sommaire

Le CCUB met à disposition plusieurs logiciels sur le cluster, et souvent plusieurs versions de chaque logiciel. Enfin d’éviter les conflits entre différentes versions d’un même logiciel, il faut généralement définir une environnement propre à chaque version. L’outil Modules Environment permet de configurer l’environnement tout en gérant les conflits et les dépendances.

Par exemple plusieurs versions de Gromacs sont installées (4.0.7, 4.5.3, etc.). Les binaires de la version 4.0.7 sont installés dans /usr/local/gromacs-4.0.7/bin et les binaires de la version 4.5.3 sont installés dans /usr/local/gromacs-4.5.3/bin. Si on mettait les 2 chemins dans le path (variable $PATH) alors la commande grompp pointerait sur le premier binaire grompp trouvé dans le path sans avoir la certitude que l’on utilise la version désirée.

Le site web de Modules Environment : http://modules.sourceforge.net

Remarque : il est déconseillé de placer les commandes de chargement de module dans votre .profile , il est préférable de charger les modules dans le shell en intéractif, et de les charger au début de vos scripts en batch.

La commande module

La commande module est une fonction directement accessible en KSH.

Pour obtenir la liste des commandes disponibles, faire module help

Modules Release 3.2.7 2009-07-30 (Copyright GNU GPL v2 1991):

  Usage: module [ switches ] [ subcommand ] [subcommand-args ]

Switches:
        -H|--help               this usage info
        -V|--version            modules version & configuration options
        -f|--force              force active dependency resolution
        -t|--terse              terse    format avail and list format
        -l|--long               long     format avail and list format
        -h|--human              readable format avail and list format
        -v|--verbose            enable  verbose messages
        -s|--silent             disable verbose messages
        -c|--create             create caches for avail and apropos
        -i|--icase              case insensitive
        -u|--userlvl <lvl>      set user level to (nov[ice],exp[ert],adv[anced])
  Available SubCommands and Args:
        + add|load              modulefile [modulefile ...]
        + rm|unload             modulefile [modulefile ...]
        + switch|swap           [modulefile1] modulefile2
        + display|show          modulefile [modulefile ...]
        + avail                 [modulefile [modulefile ...]]
        + use [-a|--append]     dir [dir ...]
        + unuse                 dir [dir ...]
        + update
        + refresh
        + purge
        + list
        + clear
        + help                  [modulefile [modulefile ...]]
        + whatis                [modulefile [modulefile ...]]
        + apropos|keyword       string
        + initadd               modulefile [modulefile ...]
        + initprepend           modulefile [modulefile ...]
        + initrm                modulefile [modulefile ...]
        + initswitch            modulefile1 modulefile2
        + initlist
        + initclear

Afficher la liste des environnement disponibles : module avail

$ module avail
----------------------- /usr/local/modulefiles -----------------------
R/2.11.0                    gromacs/4.5.5-plumed
R/2.13.0                    gromacs/4.5.5-test
R/2.15.0                    intel/11.1(default)
crystal09/1.0.1(default)    intel/12.1
gcc/4.1.2                   latex/20110705(default)
gcc/4.5.0                   molpro/2010.1.24-ompi-intel
gromacs/4.0.7               mpi/ompi/gcc/4.1.2
gromacs/4.5.1               mpi/ompi/gcc/4.5.0
gromacs/4.5.3(default)      mpi/ompi/intel
gromacs/4.5.4               mpi/vlt/vlt-gcc
gromacs/4.5.5               mpi/vlt/vlt-pgi
gromacs/4.5.5-intel         pgsql/9.0.4(default)
gromacs/4.5.5-intel12

Afficher l’aide pour un logiciel : module help

Par exemple pour obtenir l’aide du CCUB pour le logiciel Gromacs :

$ module help gromacs

----------- Module Specific Help for 'gromacs/4.5.3' --------------

  Charge l'environnement (PATH, MANPATH) pour gromacs version 4.5.3
...
**********************************
* Utilisation en mode batch SGE
..
.

Charger un environnement : module load

$ module load gromacs/4.5.4

Si la commande ne retourne rien, c’est que l’environnement a été chargé avec succès.

Afficher la liste des environnements chargés : module list

$ module list
Currently Loaded Modulefiles:
  1) gromacs/4.5.4

Afficher le contenu d’un module : module show

$ module show gromacs/4.0.7
-------------------------------------------------------------------
/usr/local/modulefiles/gromacs/4.0.7:

module-whatis    Sets the environment (PATH, MANPATH) for gromacs version 4.0.7
conflict         gromacs
setenv           GROMACSPATH /usr/local/gromacs-4.0.7
prepend-path     PATH /usr/local/gromacs-4.0.7/bin
prepend-path     MANPATH /usr/local/gromacs-4.0.7/share/man
-------------------------------------------------------------------

Décharger un environnement : module unload

$ module unload gromacs/4.5.4

Changer de version pour un environnement : module switch [modulefile]

Si une version d’un module est chargé, et que l’on veux changer de version pour le même programme, il faut utiliser module switch, ou décharger le premier module sans quoi le programme va sortir en erreur pour cause de conflit.

$ module load gromacs/4.5.4
$ module list
Currently Loaded Modulefiles:
  1) gromacs/4.5.4
$ module load gromacs/4.0.7
gromacs/4.0.7(17):ERROR:150: Module 'gromacs/4.0.7' conflicts with the currently loaded module(s) 'gromacs/4.5.4'
gromacs/4.0.7(17):ERROR:102: Tcl command execution failed: conflict     gromacs
$ module switch gromacs/4.0.7
$ module list
Currently Loaded Modulefiles:
  1) gromacs/4.0.7