Skip to content

Document the use of lmod module family to avoid loading both a local + EESSI software stack #836

Description

@casparvl

I don't have time to write these docs now, and we need to figure out where they fit (probably under 'configuring EESSI', here, but...

For site setting up EESSI and that also offer local modules which load local module environments, one can set a family in the local modulefile and configure EESSI to set the same family through EESSI_MODULE_FAMILY_NAME. The latter is listed in https://www.eessi.io/docs/using_eessi/setting_up_environment/#module-based-initialization , but we should have a small paragraph on how to use this.

Example: system has local modules to load versions of a local software stack. E.g. modules 2025 and 2026. A site can add the family(<some_family_name>) to it, to ensure that 2025 and 2026 cannot be loaded at the same time (see https://lmod.readthedocs.io/en/latest/050_lua_modulefiles.html search for 'family'). By configuring export EESSI_MODULE_FAMILY_NAME=<some_family_name> a site can make sure that the EESSI modules are considered to be part of the same family, and therefore they cannot be loaded at the same time.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions