EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Naming of attributes of Agents

Aperta
#464 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
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
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?)

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.