EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

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

Offen
#192 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation enhancement
Vorherrschende Sprache
Python
Sterne
29
Forks
12
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

## 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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Lokalisieren Sie den Abschnitt “Running MUSE” in der Dokumentation sowie den aktuellen Abschnitt 10.1.1 zum Programmieren zur Extraktion von Ausgaben. Untersuchen Sie zunächst den Standardlauf, seine TOML-Konfiguration und die von ihm erzeugten Ausgaben. Die Arbeit ist abgeschlossen, wenn ein neuer Abschnitt “Understanding and configuring basic MUSE outputs” die Standardeinstellungen, ihre TOML-Beziehung, die Anforderung dieser Ausgaben und einen Link zum fortgeschrittenen Thema erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.