common modules environment
The use of the modules software is becoming part of the standard workflow for many users. Many users have incorporated modules calls into their PBS jobs scripts and other scripts. Unfortunately, the use of different module file naming conventions between sites, between systems, and even within systems, can make it difficult to port these scripts from one system to another. A complicating factor is the use of different modules directory structures between systems.
Furthermore, as more applications make use of modules to control application access, the output of a “module avail” command is becoming longer and more difficult to navigate. This makes it difficult for users to locate the correct module files when the module files for a particular application are found in different directories from one system to another.
While sophisticated users are becoming more comfortable with the use of modules for managing their environment, there is a large class of users who prefer a standard, effective environment be loaded by default at login. These users have a reasonable expectation that upon login their environment will be setup in such a way that standard tools and libraries are available, and that these tools and libraries provide reasonably good performance.
There are some system specific module files provided by the vendor. These should not be changed. This policy does not apply to system specific modules such as the Cray modules.
This policy consists of two components:
Defining a standard naming convention.
Most applications have some version number associated with them. This policy defines the standard naming convention for module files as application/version. As an example, for some application named foobar, the module file for version 1.2.3 of this software will be located in a directory “foobar”, and be named “1.2.3”. This allows a user to load this version of the software with “module load foobar/1.2.3”.
Defining a standard directory structure for module files.
It is important that similar software be located in similar directories across systems. This portion of the policy defines where the module files for different types of software should be located. For the purpose of this policy, “some_directory” is generic and can be different across sites, across systems, and even within a system. The name of the leaf directory is what must be consistent.
Each system will have module directories as defined below:
For more details, including compliance criteria, click on additional information.
The appearance of hyperlinks does not constitute endorsement by the U.S. Air Force of this website or the information, products, or services contained therein. For other than authorized activities such as military exchanges and morale, welfare and recreation sites, the U.S. Air Force does not exercise any editorial control over the information you may find at these locations. Such links are provided consistent with the stated purpose of this DoD website.