EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE_OS

Add a section in the documentation on configuring and interpreting basic MUSE outputs

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

説明

## Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Users run the "default" case after installation, and then visualise results via JN. But a section helping them to understand these results is missing.

## Describe the solution you'd like
A clear and concise description of what you want to happen.

A new section is needed right after the "Running MUSE" section called "Understanding and configuring basic MUSE outputs". This section should explain the outputs that are produced by the default run. I assume these are based on inputs in the toml file - so this relationship should also be explained. The section should then describe the outputs that are available by default and describe how to create a toml entry to get those results output from a run. It should then link to the more advanced topic of coding to extract more outputs (currently section 10.1.1.)
 
## Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

There is no alternative as the current docs just leaves the user wondering what they are looking at, if it is correct, and how it appeared.

## Additional context
Add any other context or screenshots about the feature request here.

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

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

調査の方向性

ドキュメントの “Running MUSE” セクションと、出力を抽出するためのコーディングに関する現在のセクション 10.1.1 を見つけます。まず、デフォルトの実行、その TOML 設定、および生成される出力を確認します。新しい “Understanding and configuring basic MUSE outputs” セクションで、デフォルト値、それらと TOML の関係、出力を要求する方法、および高度なトピックへのリンクが説明されていれば完了です。

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

評価

領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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