EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Naming of attributes of Agents

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

Description

## Is your feature request related to a problem? Please describe
I find the naming of two attributes/columns in the agent.csv file— **"Name"** and **"AgentShare"**— are not intuitive, (perhaps other users might feel the same??)

According to the documentation ((https://muse-os.readthedocs.io/en/latest/inputs/agents.html), the definitions of these two attributes are:
"Name": Refers to the name **shared** by a retrofit and new-capacity agent pair.
"AgentShare": Refers to the share of the existing capacity assigned to this agent.

To me, a "Name" column normally is some kind of identifier of an agent, but here in MUSE,the value in the "Name" attribute/column is something (name) that agents **share**.

## Describe the solution you'd like

I don't have a solution, but I am thinking the **"Name"** attribute may be called something like "SharedName"??
And my understanding of the "AgentShare" attribut is it's some kind of ID of an agent, so maybe something like "agentID"???
(In addition, if "retrofit-new" pair will no longer be used in future version of MUSE, maybe the "Name" column can be even dropped?)

Guide de contribution

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

Piste de recherche

Commencez par examiner le schéma de agent.csv et la documentation des entrées de Agents référencée dans l’issue, puis suivez les endroits où Name et AgentShare sont utilisés. Déterminez la sémantique attendue et l’impact de tout changement de nom ; le travail est terminé lorsque la décision de nommage et la documentation ou les entrées concernées ont été convenues et mises à jour.

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

Évaluation

Domaine
data
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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