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 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
EnergySystemsModellingLab/MUSE_OS 的其他 Issue
-
Release notes for v2.2.0可能重新可做 @tsmbland 于 59 天前认领，目前没有进行中的 PR。 未关闭
EnergySystemsModellingLab/MUSE_OS#850 · 已指派 1 人 ·
-
bug
难度 3/5 1-2 天 新手友好度 35/100
-
[BUG] MUSE stopping without error/warning message可能重新可做 @sharwaridixit 于 335 天前认领，目前没有进行中的 PR。 未关闭bug
EnergySystemsModellingLab/MUSE_OS#804 · 2 条评论 · 已指派 3 人 ·
-
[BUG] Global commodities column name mapping conflict可能重新可做 @tsmbland 于 380 天前认领，目前没有进行中的 PR。 未关闭bug
EnergySystemsModellingLab/MUSE_OS#795 · 5 条评论 · 已指派 2 人 ·
-
难度 3/5 1-2 天 新手友好度 35/100
查看 EnergySystemsModellingLab/MUSE_OS 的全部 Issue
相似的 Issue
-
bug Size: XS
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
oposs/repo-infra#93 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 69/100
Graphify-Labs/graphify#4546 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 65/100
521xueweihan/HelloGitHub#4025 ·