... | @@ -14,6 +14,8 @@ Idea: seamless stacking of multiple module hierarchies, use cases: |
... | @@ -14,6 +14,8 @@ Idea: seamless stacking of multiple module hierarchies, use cases: |
|
* modules on another filesystem or location than the default (@PSI: `/opt/psi`)
|
|
* modules on another filesystem or location than the default (@PSI: `/opt/psi`)
|
|
* ...
|
|
* ...
|
|
|
|
|
|
|
|
Overlays can be stacked.
|
|
|
|
|
|
=== Overlay configuration
|
|
=== Overlay configuration
|
|
|
|
|
|
==== Definition
|
|
==== Definition
|
... | @@ -44,17 +46,32 @@ The user configuration file is queried first and can be used to overwrite the de |
... | @@ -44,17 +46,32 @@ The user configuration file is queried first and can be used to overwrite the de |
|
|
|
|
|
----
|
|
----
|
|
---
|
|
---
|
|
name_of_overlay1:
|
|
name_of_overlay:
|
|
root_dir: <DIR>
|
|
root_dir: <DIR>
|
|
modulefiles_root_dir: <DIR>
|
|
modulefiles_root_dir: <DIR>
|
|
type: normal|hidding|replacing
|
|
type: normal|hidding|replacing
|
|
name_of_overlay2:
|
|
|
|
...
|
|
...
|
|
----
|
|
----
|
|
|
|
|
|
`root_dir`::
|
|
`name_of_overlay`:: Is the name of the overlay.
|
|
|
|
|
|
|
|
`root_dir`:: Is the root directory for software installation.
|
|
The specification of `root_dir` is mandatory.
|
|
The specification of `root_dir` is mandatory.
|
|
|
|
|
|
If `modulefiles_root_dir` is not specified, `root_dir` is used.
|
|
`modulefiles_root_dir`:: Is the root directory for the installation of modulefiles. If it is not specified, `root_dir` is used. This is the most usual case.
|
|
|
|
|
|
|
|
`type`:: Specifies the type of the overlay. The default is `normal`. See below for the type specifications.
|
|
|
|
|
|
|
|
==== Overlay stacks
|
|
|
|
|
|
|
|
It is possible to use/load multiple overlays at the same time. Multiple used/loaded overlays are organised as stack. Using/loading an overlay pushes it on top of the stack. It is only possible to unuse/unload the overlay on top of the stack.
|
|
|
|
|
|
|
|
==== Overlay types
|
|
|
|
|
|
|
|
`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:
|
|
|
|
|
|
|
|
`hiding`:: An overlay of this types hides all modules with the same name in previous loaded overlays.
|
|
|
|
|
|
If `type |
|
`replacing``:: TBW |
|
\ No newline at end of file |
|
\ No newline at end of file |