EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Add documentation page on example models

Aperta
#654 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

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia leggendo il README esistente in src/muse/data e i tutorial che menzionano default e default_timeslice. Sposta e riordina le descrizioni dei modelli di esempio nella documentazione in modo che gli utenti possano trovarle, e verifica che gli esempi pertinenti siano coperti e che la documentazione venga compilata o visualizzata correttamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.