Pmodules/doc/Overlays.adoc

Overlays

Table of Contents

• 1. What are Overlays and for what can they be used?
• 2. Overlay configuration
  • 2.1. System wide
  • 2.2. User defined overlays
• 3. Working with overlays
• 4. Building modules
  • 4.1. With a YAML variants file
  • 4.2. With a legacy variants file

Please note: This document is work in progress!

1. What are Overlays and for what can they be used?

2. Overlay configuration

2.1. System wide

Example 1. A system wide configuration file /opt/psi/config/Pmodules.yaml

DefaultGroups: Tools:Programming
DefaultReleaseStages: stable
ReleaseStages: unstable:stable:deprecated
TmpDir: /opt/psi/var/tmp/${USER}
DistfilesDir: /opt/psi/var/distfiles

Overlays:
  base:
    install_root: /opt/psi
  devel:
    install_root: /opt/psi
    modulefiles_root: ${HOME}/modulefiles

2.2. User defined overlays

Each user can define his own overlays in $HOME/.Pmodules/Pmodules.yaml.

3. Working with overlays

4. Building modules

The old format of the variants file is simple but very limited and almost impossible to extend for new features. To overcome the limitations a new format using YAML for variants files has been introduced. For the time being both format are supported. But it is highly recommended to use the YAML format for new modules and to migrate existing variants files in the old format to the new.

4.1. With a YAML variants file

Example 2. A YAML variants file

overlay: base

hdf5_serial/1.12.2:
- with: gcc/{5.5.0,6.5.0,7.5.0,10.2.0,10.3.0}
  relstage: stable
- with: gcc/{8.5.0,9.5.0,11.3.0,12.1.0}
  relstage: unstable
  overlay: devel

YAML format of varaints file

overlay: <default-overlay>
systems: <default-systems>

<module-name>/<version>:
  - with: <ohierarchical-build-dependencies>
    dependencies: <other-build-dependencies>
    relstate: <release-stage>
    overlay: <overlay>
    systems: <systems>
  ...
...

4.2. With a legacy variants file