Documentation [UMBRELLA]
@tsmbland がすでに取り組んでいます。
2024年4月19日 から。
評価
この issue はまだ評価されていません。
説明
Umbrella issue documenting work that needs to be done on the documentation
GENERAL: General issues related to the documentation (e.g. structure)
- #191
- #473
INFRASTRUCTURE: Issues related to installing MUSE and developer infrastructure (e.g. tests)
- #261
- #257
- #165
- #126
- #154
TUTORIALS: Issues related to notebooks and tutorials
- #99
- #258
- #264
- #207
- #190
- #340
- #282
- #291
- #295
- #337
Notes:
- The main issue here is that the tutorials do not appear to be up to date with the current version of the code. A priority would be to bring the tutorials up to date, and ideally have a system in place which checks when tutorials need to be updated (#99)
- As a new user to MUSE, working through the tutorials was a confusing experience as my outputs almost never matched the figures in the documentation (or otherwise failed to run without error). Bringing the tutorials up to date would certainly help, but I also think more information needs to be added to fully describe the model configurations/parameters used to generate the figures (for example the
MaxCapacityGrowthparameter appears to have been changed in 8.1, but this isn't documented). The aim is to give users all the information they need to replicate the figures, starting from the default model. - For each tutorial, I think it would be very useful to have a very short summary to describe which files need to be changed when the user wants to add an agent/region/commodity etc.. This could be a 'checklist' of sorts. I think would be a very useful reference to guide users when the come to do this on their own, to ensure they don't accidentally skip any steps.
- I think some of the figures could be improved/clarified. e.g. for the line plots, what do the shaded regions indicate? There are a series of additional analysis notebooks together with the model files which create clearer figures, but these are unused in the documentation
MODEL DESCRIPTION: Specific cases where the model description or background info needs improvement
Implementation details:
- #218
- #196
- #195
- #188
Inputs/parameters:
- #492
- #474
- #265
- #263
- #208
- #206
- #205
- #203
- #202
- #201
- #200
- #199
- #198
- #197
Outputs:
- #192
- 主要言語
- Python
- スター
- 29
- フォーク
- 12
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
EnergySystemsModellingLab/MUSE_OS のほかの issue
-
Release notes for v2.2.0再び着手できるかも @tsmbland が 52 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
EnergySystemsModellingLab/MUSE_OS#850 · 担当者 1 名 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
[BUG] MUSE stopping without error/warning message再び着手できるかも @sharwaridixit が 328 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンbug
EnergySystemsModellingLab/MUSE_OS#804 · コメント 2 件 · 担当者 3 名 ·
-
[BUG] Global commodities column name mapping conflict再び着手できるかも @tsmbland が 373 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンbug
EnergySystemsModellingLab/MUSE_OS#795 · コメント 5 件 · 担当者 2 名 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
EnergySystemsModellingLab/MUSE_OS の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
lugassawan/swe-workbench#799 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
vllm-project/vllm#61131 ·
メンテナーはふだん 1 日以内に返信
-
Non-string form field names raise AttributeError when files are attached対応中かも @nightcityblade が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
kubernetes-client/python#2735 ·
メンテナーはふだん 1 日以内に返信
-
desktop help wanted test
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信