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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#836 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Empieza por la documentación existente sobre la inicialización de EESSI basada en módulos y la sección sugerida sobre inyecciones del host/configuración de EESSI para decidir dónde encaja el párrafo. Explica cómo los archivos de módulos locales pueden usar family(...) y cómo EESSI_MODULE_FAMILY_NAME incluye los módulos de EESSI en esa familia; se considerará terminado cuando la guía cubra el ejemplo de 2025/2026 y enlace a la documentación de familias de Lmod.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
14
Forks
54
Merge medio
11 h 2 min
PR fusionados (30 d)
41

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de EESSI/docs

Todos los issues de EESSI/docs

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.