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

未关闭 适合新手
#836 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
72/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

先查看现有的基于模块的 EESSI 初始化文档,以及建议的主机注入/配置 EESSI 部分,以确定段落适合放在哪里。说明本地 modulefile 如何使用 family(...),以及 EESSI_MODULE_FAMILY_NAME 如何将 EESSI 模块归入该 family;当指南涵盖 2025/2026 示例并链接到 Lmod 的 family 文档时,即视为完成。

由索引模型根据 Issue 内容生成。

描述

good first issue

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.

主要语言
Python
星标
14
派生
54
平均合并
11 小时 2 分钟
30 天内合并 PR
41

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

EESSI/docs 的其他 Issue

查看 EESSI/docs 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。