Politique de nommage des modules

par Nathalie Furmento
Annonces, Documentation | Pas de commentaire

Les utilisateurs peuvent installer des modules à partager avec l'ensemble de la communauté dans le répertoire /cm/shared/dev. Il suffit d'appartenir au groupe unix plafrim-dev (merci de faire un ticket à plafrim-support pour demander d'être ajouté au groupe).

Afin de limiter la prolifération de modules et de permettre une meilleure lisibilité, il a été décidé de classer les modules en catégories. Chaque module appartient à une catégorie, qui peut être par exemple trace ou statistics.

La politique de nommage des modules est la suivante:

<catégorie>/<module>/<option>/<version>

en ayant autant d'options que nécessaire, ou aucune.

Les membres du groupe plafrim-dev peuvent créer des modules dans l'espace de travail /cm/shared/dev/.

  • Les fichiers modules doivent être placés dans le sous-répertoire modulefiles et suivre la politique de nommage. Ainsi la librairie fxt appartenant à la catégorie trace avec la version 0.3.1 et sans option particulière aura comme fichier module /cm/shared/dev/modulefiles/trace/fxt/0.3.1.
  • Les fichiers d'installation des modules doivent être placé dans le sous-répertoire apps. Il est fortement conseillé de garder la même hiérarchie de répertoires pour l'installation du module, ainsi ce même module fxt devrait être installé dans le répertoire /cm/shared/dev/apps/trace/fxt/0.3.1.
  • faites attention à ce que tous les fichiers soient lisibles par l'ensemble des utilisateurs de la plateforme, voir ci-dessous pour une commande qui positionne les bonnes permissions.
  • Il est également conseillé d'avoir une description adéquate dans whatis afin que la commande module show xxx réponde quelque chose de plus informatif que loads the xxx environment.

Le module tools/module_cat fournit les outils suivants:

  • module_list qui liste les catégories existantes
  • module_add, module_init, module_add, module_rm pour modifier la variable d'environnement MODULEPATH qui définit où localiser les modules
  • module_perm qui positionne les bonnes permissions sur le répertoire donné en paramètre
  • module_search qui affiche les modules dont le nom contient la chaîne donnée en paramètre, par exemple module_search hwloc

Si vous pensez qu'il est nécessaire d'ajouter une nouvelle catégorie, merci d'envoyer un courriel à la liste de diffusion plafrim-users.

Sur la même thématique