EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Naming of attributes of Agents

Abierto
#464 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Python
Estrellas
29
Forks
12
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

## 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?)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Empieza revisando el esquema de agent.csv y la documentación de entrada de Agents enlazada en el issue; después, rastrea dónde se consumen Name y AgentShare. Determina la semántica prevista y el impacto de cualquier cambio de nombre; se considera terminado cuando la decisión sobre los nombres y la documentación o las entradas afectadas se hayan acordado y actualizado.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
data
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.