... | ... | @@ -14,7 +14,7 @@ Idea: seamless stacking of multiple module hierarchies, use cases: |
|
|
* modules on another filesystem or location than the default (@PSI: `/opt/psi`)
|
|
|
* ...
|
|
|
|
|
|
Overlays can be stacked.
|
|
|
Overlays can be stacked. The first overlay - the overlay at the bottom of the stack - is called "base overlay".
|
|
|
|
|
|
=== Overlay configuration
|
|
|
|
... | ... | @@ -30,6 +30,12 @@ An overlay is defined by the two root directories. Different names can be used f |
|
|
|
|
|
If only the root directory for the software installation is specified, this is also used as root for the modulefiles.
|
|
|
|
|
|
==== Limitations
|
|
|
|
|
|
The relative directory structure of a hierarchy group must be identical to the base overlay. It is also not possible to define a new hierarchical group.
|
|
|
|
|
|
Note: an overlay can add new non-hierarchical groups.
|
|
|
|
|
|
==== Configuration files
|
|
|
|
|
|
Configuration files are in YAML format.
|
... | ... | @@ -42,8 +48,7 @@ All overlays must be defined in the system or user configuration file. |
|
|
|
|
|
The user configuration file is queried first and can be used to overwrite the definition of an overlay in the system configuration file.
|
|
|
|
|
|
==== Format
|
|
|
|
|
|
Format:
|
|
|
----
|
|
|
---
|
|
|
name_of_overlay:
|
... | ... | @@ -72,11 +77,11 @@ The 'overlay' at the bottom of the stack is called the base overlay and cannot b |
|
|
|
|
|
`normal`:: In an overlay of this types the modules in the overlay are added to the already available modules provided by the overlays on the stack. If modules with identical name/version exist in multiple overlays, the module from the overlay which is higher on the stack is used. In other words modules with identical name/version are replaced by overlays loaded later.
|
|
|
+
|
|
|
Example: Assume we have the overlays `base` and `private`. In the base overlay the modules `gnuplot/5.4.0` and `gnuplot/5.4.2` are available. In private overlay we have `gnuplot/5.4.2` and `gnuplot/5.4.3` (maybe compiled with a different configuration).
|
|
|
Example: Assume we have the overlays `base` and `private`. In the base overlay are the modules `git/2.33.1`, `gnuplot/5.4.0` and `gnuplot/5.4.2` in the group `Tools`. In private overlay are the modules `gnuplot/5.4.2` and `gnuplot/5.4.3` (maybe compiled with a different configuration).
|
|
|
+
|
|
|
After loading the private overlay the following Gnuplot modules are available:
|
|
|
+
|
|
|
* `gnuplot/5.4.0` from the base overlay
|
|
|
* `git/2.33.1`and `gnuplot/5.4.0` from the base overlay
|
|
|
* `gnuplot/5.4.2` and `gnuplot/5.4.3`from the private overlay
|
|
|
+
|
|
|
Note: the module `gnuplot/5.4.2` from the base overlay has been replaced by the module with the same name from the private overlay.
|
... | ... | @@ -87,7 +92,15 @@ Example: Assume we have the same overlays and Gnuplot modules as in the example |
|
|
+
|
|
|
After loading the private overlay with type `hiding` the following Gnuplot modules are available:
|
|
|
+
|
|
|
* `git/2.33.1` from the base overlay
|
|
|
* `gnuplot/5.4.2` and `gnuplot/5.4.3`from the private overlay
|
|
|
+
|
|
|
Note: the Gnuplot modules from the base overlay are hidden!
|
|
|
`replacing``:: TBW |
|
|
\ No newline at end of file |
|
|
|
|
|
`replacing`:: A overlay of this types replaces hole groups.
|
|
|
+
|
|
|
Example: If you load the private overlay from the examples above as replacing, the following modules are available in the group `Tools`:
|
|
|
+
|
|
|
* `gnuplot/5.4.2` and `gnuplot/5.4.3`from the private overlay
|
|
|
+
|
|
|
Note: the Git module from the base overlay is not available any more. |
|
|
\ No newline at end of file |