Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Documentation [UMBRELLA]

Abierto
  • ¿Algo no está bien?
#262 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@tsmbland ya está trabajando en esto.

Desde el 19/4/2024.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

documentation umbrella

Umbrella issue documenting work that needs to be done on the documentation

GENERAL: General issues related to the documentation (e.g. structure)

  • #191
  • #473

INFRASTRUCTURE: Issues related to installing MUSE and developer infrastructure (e.g. tests)

  • #261
  • #257
  • #165
  • #126
  • #154

TUTORIALS: Issues related to notebooks and tutorials

  • #99
  • #258
  • #264
  • #207
  • #190
  • #340
  • #282
  • #291
  • #295
  • #337

Notes:

  • The main issue here is that the tutorials do not appear to be up to date with the current version of the code. A priority would be to bring the tutorials up to date, and ideally have a system in place which checks when tutorials need to be updated (#99)
  • As a new user to MUSE, working through the tutorials was a confusing experience as my outputs almost never matched the figures in the documentation (or otherwise failed to run without error). Bringing the tutorials up to date would certainly help, but I also think more information needs to be added to fully describe the model configurations/parameters used to generate the figures (for example the MaxCapacityGrowth parameter appears to have been changed in 8.1, but this isn't documented). The aim is to give users all the information they need to replicate the figures, starting from the default model.
  • For each tutorial, I think it would be very useful to have a very short summary to describe which files need to be changed when the user wants to add an agent/region/commodity etc.. This could be a 'checklist' of sorts. I think would be a very useful reference to guide users when the come to do this on their own, to ensure they don't accidentally skip any steps.
  • I think some of the figures could be improved/clarified. e.g. for the line plots, what do the shaded regions indicate? There are a series of additional analysis notebooks together with the model files which create clearer figures, but these are unused in the documentation

MODEL DESCRIPTION: Specific cases where the model description or background info needs improvement

Implementation details:

  • #218
  • #196
  • #195
  • #188

Inputs/parameters:

  • #492
  • #474
  • #265
  • #263
  • #208
  • #206
  • #205
  • #203
  • #202
  • #201
  • #200
  • #199
  • #198
  • #197

Outputs:

  • #192
Lenguaje dominante
Python
Estrellas
29
Forks
12
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

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 EnergySystemsModellingLab/MUSE_OS

Todos los issues de EnergySystemsModellingLab/MUSE_OS

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.