EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Add a section in the documentation on configuring and interpreting basic MUSE outputs

Ouverte
#192 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation enhancement
Langage dominant
Python
Étoiles
29
Forks
12
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

## Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Users run the "default" case after installation, and then visualise results via JN. But a section helping them to understand these results is missing.

## Describe the solution you'd like
A clear and concise description of what you want to happen.

A new section is needed right after the "Running MUSE" section called "Understanding and configuring basic MUSE outputs". This section should explain the outputs that are produced by the default run. I assume these are based on inputs in the toml file - so this relationship should also be explained. The section should then describe the outputs that are available by default and describe how to create a toml entry to get those results output from a run. It should then link to the more advanced topic of coding to extract more outputs (currently section 10.1.1.)
 
## Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

There is no alternative as the current docs just leaves the user wondering what they are looking at, if it is correct, and how it appeared.

## Additional context
Add any other context or screenshots about the feature request here.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Repérez la section “Running MUSE” de la documentation ainsi que la section 10.1.1 actuelle sur le codage pour extraire des sorties. Examinez d’abord l’exécution par défaut, sa configuration TOML et les sorties qu’elle produit. Le travail est terminé lorsqu’une nouvelle section “Understanding and configuring basic MUSE outputs” explique les valeurs par défaut, leur relation avec TOML, comment les demander et contient un lien vers le sujet avancé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.