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

Aperta Adatta ai principianti
  • Qualcosa non va?
#836 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia dalla documentazione esistente sull’inizializzazione di EESSI basata sui moduli e dalla sezione suggerita sulle iniezioni dell’host/configurazione di EESSI per decidere dove inserire il paragrafo. Spiega come i file di modulo locali possono usare family(...) e come EESSI_MODULE_FAMILY_NAME inserisce i moduli EESSI in quella famiglia; il lavoro è completato quando le indicazioni trattano l’esempio 2025/2026 e rimandano alla documentazione di Lmod sulle famiglie.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
14
Fork
54
Merge medio
11h 2m
PR unite (30g)
41

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di EESSI/docs

Tutte le issue di EESSI/docs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.