Module naming policy

by Nathalie Furmento
Announcement, Documentation | No Comments

Users can install modules they want to share with the community in the directory /cm/shared/dev. To do so, one needs to belong to the unix group plafrim-dev (just send a ticket to plafrim-support to be added in the group).

In order to increase and to ease the use of the modules on the platform, modules are grouped within categories. Each module belongs to a specific category, which can be for example trace or statistics.

The module naming policy is as follows:

<category>/<module>/<option>/<version>

the number of options being between 0 and as many as you want.

Everyone in the group plafrim-dev is allowed to create new modules in the directory /cm/shared/dev.

  • Modules files must be placed in the subdirectory modulefiles and follow the naming policy. Thus a module named fxt in the category trace with the version 0.3.1 and without any specific option will be stored in the file /cm/shared/dev/modulefiles/trace/fxt/0.3.1.
  • Installation module files must be placed in the subdirectory apps. The installation of the packages should follow the same layout as the modulefiles, i.e the module should be installed in the directory /cm/shared/dev/apps/trace/fxt/0.3.1.
  • make sure all the files can be read by anyone on the platform., see below for a tool to do so
  • have a real description in whatis, the command module show xxx should say something more meaningful than loads the xxx environment

The module tools/module_cat provides the following tools

  • module_list to list the existing categories
  • module_add, module_init, module_add, module_rm to modify the environment variable MODULEPATH which defines the folders in which to look for modules
  • module_perm to set the correct permissions on a given directory
  • module_search to search all modules whose name have the given string, e.g module_search hwloc

To add a new category, send a email to the plafrim-users mailing-list.

On the same thematic