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

オープン 初心者向け
  • 何か問題がありますか？
#836 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

既存のEESSIのモジュールベース初期化に関するドキュメントと、提案されているホストインジェクション/EESSIの設定セクションを確認し、段落をどこに配置するか決めてください。ローカルのmodulefileでfamily(...)を使う方法と、EESSI_MODULE_FAMILY_NAMEによってEESSIモジュールをそのファミリーに含める方法を説明してください。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分
マージ済み PR（30日）
41

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

EESSI/docs のほかの issue

EESSI/docs の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。