EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS
Add documentation page on example models
- Vorherrschende Sprache
- Python
- Sterne
- 29
- Forks
- 12
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
There are no descriptions about the example models in the documentation (apart from some mention of `default` and `default_timeslice` in the tutorials). We have a readme file in `src/muse/data` with some basic descriptions, but we should tidy this up and move to the documentation so it's visible to users
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit, das vorhandene README in src/muse/data und die Tutorials zu lesen, in denen default und default_timeslice erwähnt werden. Verschiebe und überarbeite die Beschreibungen der Beispielmodelle in der Dokumentation, damit Nutzer sie finden können, und überprüfe, dass die relevanten Beispiele abgedeckt sind und die Dokumentation korrekt erstellt oder gerendert wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100