Utiliser des modules

Les serveurs de calcul de Calcul Canada peuvent exécuter la totalité des logiciels fonctionnant sous Linux. Dans le cas le plus simple, le logiciel dont vous avez besoin sera déjà installé sur l'un des serveurs de calcul. Il sera alors accessible sous la forme d'un module. Si ce n'est pas le cas, vous pouvez soit demander à notre équipe de l'installer pour vous, soit le faire vous-même.

Les modules sont des fichiers de configuration qui contiennent des instructions afin de modifier votre environnement logiciel. Cette architecture modulaire permet d'avoir plusieurs versions d'une même application installées sans que celles-ci entrent en conflit. Pour les nouveaux serveurs de Calcul Canada, les modules sont gérés par l'outil Lmod, développé au TACC. Cet outil remplace Environment Modules, qui est utilisé sur la plupart des anciens serveurs. Si vous êtes familier avec ce système, vous ne devriez pas être trop dépaysé, car Lmod a été conçu pour être très similaire à Environment Modules. Référez-vous alors à la section #Lmod vs Environment Modules pour connaître les différences principales entre les deux systèmes.

Un fichier module (« modulefile ») contient les informations nécessaires pour rendre disponible une application ou une bibliothèque dans la session de l'usager. Typiquement, un fichier module contient des instructions qui modifient ou initialisent les variables d'environnement, comme PATH et LD_LIBRARY_PATH, pour utiliser les différents logiciels installés.

Principales commandes de module

La commande module a plusieurs sous-commandes. La syntaxe normale est

[nom@serveur ~]$ module commande [autres options]

Pour connaître la liste des sous-commandes disponibles, utiliser

[nom@serveur ~]$ module help

Sous-commande avail

Pour lister les modules disponibles sur un système donné, utiliser

[nom@serveur ~]$ module avail

Vous pouvez obtenir une liste de modules disponibles pour une bibliothèque ou un outil particulier

[nom@serveur ~]$ module avail openmpi

Notez que la commande module avail peut ne pas lister certains modules qui sont incompatibles avec les modules que vous avez chargé. Pour voir la liste complète de tous les modules, utilisez la sous-commande spider documentée ci-dessous.

Sous-commande spider (Lmod seulement)

La sous-commande spider recherche l'arborescence complète de tous les modules et l'affiche.

[nom@serveur ~]$ module spider

Si vous spécifiez le nom d'une application, par exemple avec

[nom@serveur ~]$ module spider openmpi

cela vous affichera la liste de toutes les versions disponibles.

Si vous spécifiez le nom de l'application avec son numéro de version, par exemple avec

[nom@serveur ~]$ module spider openmpi/1.8.4

cela vous affichera la liste des options de module à charger afin d'accéder à cette version.

Sous-commande list

La sous-commande list affiche les modules qui sont présentement chargés dans votre environnement.

[nom@serveur ~]$ module list

Sous-commande load

La sous-commande load permet de charger un module donné. Par exemple

[nom@serveur ~]$ module load gcc/4.8

pourrait charger le module du compilateur GCC version 4.8.

Vous pouvez charger plus d'un module avec une même commande. Par exemple

[nom@serveur ~]$ module load gcc/4.8 mpi/openmpi/1.8.4

chargerait à la fois le compilateur GCC 4.8 et la bibliothèque OpenMPI 1.8.4 compilée pour GCC.

Si vous chargez un module qui est incompatible avec un module déjà chargé, Lmod vous indiquera qu'il a remplacé l'ancien module par le nouveau. Ceci peut se produire en particulier pour des compilateurs et des implémentations MPI.

Sous-commande unload

Pendant de la sous-commande load, la sous-commande unload enlève un module de votre environnement. Par exemple

[nom@serveur ~]$ module unload gcc/4.8

enlèverait le compilateur GCC 4.8 de votre environnement.

Si certains modules dépendaient de ce compilateur, Lmod vous indiquera qu'ils ont été désactivés.

Sous-commande purge

La sous-commande purge permet d'enlever d'un seul coup tous les modules que vous avez chargés.

[nom@serveur ~]$ module purge

Certains modules peuvent être marqués comme sticky (permanent) par les administrateurs système. Ces derniers ne seront pas enlevés.

Sous-commandes show, help et whatis

Les sous-commandes show, help et whatis permettent d'avoir de l'information supplémentaire sur un module donné. La sous-commande show affiche l'intégralité du module, la commande help affiche un message d'aide, et la commande whatis montre une description du module.

[nom@serveur ~]$ module help gcc/4.8

Sous-commande apropos ou keyword

Les sous-commandes apropos ou keyword permettent de chercher un mot-clé dans la totalité des modules. Si vous ne savez pas quel module est approprié pour réaliser votre calcul, vous pouvez ainsi chercher dans les descriptions.

Chargement automatique des modules

Nous vous déconseillons de charger des modules automatiquement dans votre .bashrc. Nous vous recommandons plutôt de charger les modules nécessaire au besoin, par exemple dans vos scripts de tâches. Afin de faciliter le chargement d'un grand nombre de modules, nous vous recommandons d'utiliser une collection de modules.

Collections de modules (Lmod seulement)

Lmod vous permet de créer une collection de modules. Pour ce faire, chargez les modules requis. Par exemple:

[nom@serveur ~]$ module load gcc/4.8 openmpi/1.8 mkl

Utilisez ensuite la commande save pour sauvegarder cette collection :

[nom@serveur ~]$ module save mes_modules

L'argument mes_modules est un nom que vous donnez à la collection.

Vous pouvez ensuite, dans une session ultérieure ou dans une tâche, restaurer cette collection avec la commande

[nom@serveur ~]$ module restore mes_modules

Modules cachés

Certains modules sont cachés. Vous pouvez les ignorer. Il s'agit généralement de modules que vous n'avez pas à charger manuellement. Ils sont chargés automatiquement selon les besoins.

Lmod vs Environment Modules

Les principales différences entre l'environnement mis à votre disposition sur les nouveaux serveurs de Calcul Canada et les serveurs que vous avez utilisé par le passé sont les suivantes.

Hiérarchie de modules

La majorité des systèmes utilisent une structure de modules plate : tous les modules sont à un même niveau. Ceci devient problématique lorsqu'un grand nombre de combinaisons de versions de différents modules sont disponibles sur un système. Par exemple, si vous avez à utiliser la bibliothèque FFTW, et que le module fftw est disponible en plusieurs versions, dont une version compilée avec le compilateur gcc version 4.8 et openmpi 1.6, vous avez peut-être déjà vu des modules nommés openmpi/1.6_gcc4.8 et fftw/3.3_gcc4.8_openmpi1.6. Ceci n'est ni élégant, ni pratique. Pour résoudre ce problème, nous utilisons une hiérarchie de modules. Plutôt que d'utiliser la commande

[nom@serveur ~]$ module load gcc/4.8 openmpi/1.6_gcc4.8 fftw/3.3_gcc4.8_openmpi1.6

vous utiliserez la commande

[nom@serveur ~]$ module load gcc/4.8 openmpi/1.6 fftw/3.3

Ceci est rendu possible en utilisant une hiérarchie de modules. Le module fftw/3.3 qui est chargé ne sera pas le même si vous avez chargé au préalable le compilateur Intel ou le compilateur GCC.

L'inconvénient d'utiliser une hiérarchie de modules est que, puisque des modules peuvent avoir le même nom, seuls les modules compatibles avec les modules parents sont affichés par la commande module avail. Charger un parent est donc un prérequis afin d'avoir accès à certains modules. Pour avoir l'information complète, Lmod rend disponible la commande module spider. Celle-ci parcours la hiérarchie complète et afficher tous les modules. En spécifiant un module et une version particulière, il est alors possible quels sont les chemins de la hiérarchie qui permettent de charger le module désiré.

Collections de modules

Les collections de modules sont l'une des fonctionnalités additionnelles fournies par Lmod. Voir cette section pour plus de détails.

Une seule version chargée à la fois

Lmod refusera de charger deux versions d'un même module en même temps. Par exemple, vous ne pourrez pas charger les versions 4.8 et 5.4 du compilateur GCC en même temps.

Un seul module d'une même famille chargé à la fois

Il est possible pour les administrateurs de spécifier que deux modules portant des noms différents sont de la même famille. Lmod refusera alors de charger deux modules de la même famille. Des exemples typiques seraient les modules de compilateurs (gcc, intel), les modules MPI (openmpi, mvapich2), ou les modules de la bibliothèque BLAS (mkl, openblas).

Remplacement automatique de modules

Lorsque Lmod détecte deux modules de la même famille, ou deux versions du même module, la commande module load remplacera automatiquement le module original par celui qui doit être chargé. Dans le cas où le module remplacé est un noeud de la hiérarchie de modules, les modules dépendants seront chargés de nouveau s'il existe une version compatible, ou désactivés dans le cas contraire.

Modules permanents

Lmod permet aux administrateurs de définir un module comme étant permanent (sticky). Un tel module ne sera pas enlevé via la commande module purge.

GNU Compiler Collection, an open source compiler collection

Message Passing Interface