EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Naming of attributes of Agents

オープン
#464 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
29
フォーク
12
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず agent.csv のスキーマと issue にリンクされている Agents の入力ドキュメントを確認し、その後、Name と AgentShare がどこで使用されているかを追跡します。意図されたセマンティクスと、名前を変更した場合の影響を明確にします。名前に関する決定と、影響を受けるドキュメントまたは入力について合意し、更新されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
data
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。