EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Confusion about the `CommodityType` parameter

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

Description

The [documentation for this parameter](https://muse-os.readthedocs.io/en/latest/inputs/commodities.html) states that "Service" should be used for end-use commodities such as heating, however the example models/tutorials use "Energy" for the `heat` and `cook` commodities. This is confusing and needs to be clarified.

Looking at the code, "Energy" and "Environmental" are the only `CommodityType` options that are directly referenced. For end-use commodities, the important thing is that they get picked up by the `is_enduse` function, but this will be true for any products that are not the "Environmental" type (so it doesn't actually matter if it's "Service" or "Energy")

Guide de contribution

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

Piste de recherche

Commencez par la documentation CommodityType liée, puis comparez les exemples heat et cook dans les modèles d’exemple/tutoriels. Lisez la fonction is_enduse et son traitement de Energy, Environmental et Service. Le travail est terminé lorsque la documentation et les exemples sont clairement cohérents sur la valeur valide de end-use et expliquent pourquoi.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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