EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

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

Aperta
#192 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation enhancement
Lingua principale
Python
Stelle
29
Fork
12
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.