...
In case the library depends on the Data Dictionary (DD) version, this DD version information shall be included in the {{ <LIB_VERSION>}} string.
Modules
The module name explicitly identifies the library’s name and version and the compiler’s name and version.
| Code Block |
|---|
<ROOT_MODULES_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION> |
Example: {{<ROOT_MODULES_PATH>/xmllib/1.0-ifort-17}}
Loading the module is thus done via:
...
A module adds a single directory to the {{the $PKG_CONFIG_PATH}} (making a single version available at compile time) and adds <ROOT_LIB_PATH>/<LIB_NAME>/lib in $LD_LIBRARY_PATH (making all versions available at run time for dynamically loading the library, see below).
Each module is conflicting with the others (of the same library). Meta-modules allowing loading at once all modules in a coherent environment for a given workflow/application (if not conflicting) will be available. In case a complex workflow/application contains components using conflicting libraries (i.e. using different versions/compilers for the same library), the relevant module must be loaded prior to the component compilation, and then unloaded.
Libraries
The library layout explicitly identifies the library’s name and version and the compiler’s name and version and puts the various files of the library as follows:
| Code Block |
|---|
<ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/include/*.h |
...
<ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/include/*.mod <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/lib/*.a <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/lib/*.so |
...
<ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/lib/pkgconfig/<LIB_NAME>.pc |
...
<ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/src |
...
<ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/example
<ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/man |
Note that all pc files have the same name, for the sake of simplicity (for the code developer).
In addition, a “central” repository
| Code Block |
|---|
<ROOT_LIB_PATH>/<LIB_NAME>/lib |
contains links to the *.so files (for all library versions and compiler names and versions), in order to keep $LD_LIBRARY_PATH length below the operating system limit.
| Code Block |
|---|
<ROOT_LIB_PATH>/<LIB_NAME>/lib/lib<LIB_NAME>-<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>.so |
...
-> ../<LIB_VERSION>-<COMPILER_NAME>-<COMPILER_VERSION>/lib/lib<LIB_NAME>. |
...
s |
Example
...
| Code Block |
|---|
<ROOT_LIB_PATH>/xmllib/1.0-ifort-17/include/*.h *. |
...
mod <ROOT_LIB_PATH>/xmllib/1.0-ifort-17/lib/*.a *.so |
...
<ROOT_LIB_PATH>/xmllib/1.0-ifort-17/lib/pkgconfig/xmllib.pc |
...
<ROOT_LIB_PATH>/xmllib/1.0-ifort-17/src |
...
<ROOT_LIB_PATH>/xmllib/1.0-ifort-17/example <ROOT_LIB_PATH>/xmllib/1.0-ifort-17/man <ROOT_LIB_PATH>/xmllib/lib/libxmllib-1.0-ifort-17.so |
...
-> ../1.0-ifort-17/lib/libxmllib.so |
Example of XMLLIB installation based on IMAS based release
| Code Block |
|---|
swimas
|-- etc
| `-- modulefiles
| `-- xmllib
| |-- 4.0-GCC-6.1.0
| `-- 4.0-intel-17.0.4
`-- extra
`-- xmllib
|-- 4.0-GCC-4.8.5
| |-- include
| | |-- f90_file_reader.mod
| | |-- mod_f90_kind.mod
| | |-- string_manipulation_tools.mod
| | |-- xml2eg_mdl.mod
| | |-- xml_file_reader.mod
| | |-- xmllib_parser.mod
| | |-- xmllib_pathquery.mod
| | `-- xmllib_types.mod
| `-- lib
| |-- libxmllib.a
| `-- pkgconfig
| `-- xmllib.pc
|-- 4.0-intel-17.0.4
| |-- include
| | |-- f90_file_reader.mod
| | |-- mod_f90_kind.mod
| | |-- string_manipulation_tools.mod
| | |-- xml2eg_mdl.mod
| | |-- xml_file_reader.mod
| | |-- xmllib_parser.mod
| | |-- xmllib_pathquery.mod
| | `-- xmllib_types.mod
| `-- lib
| |-- libxmllib.a
| `-- pkgconfig
| `-- xmllib.pc
`-- lib
|-- libxmllib-4.0-GCC-4.8.5.a -> ../4.0-GCC-4.8.5/lib/libxmllib.a
`-- libxmllib-4.0-intel-17.0.4.a -> ../4.0-intel-17.0.4/lib/libxmllib.a |