iiasa / iiasa/message_ix

Extend documentation on periods befor the first model year

Open
#599 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs enh
Dominant language
Jupyter Notebook
Stars
150
Forks
178
Avg merge
17h 32m
Merged PRs (30d)
2

Description

https://github.com/iiasa/message_ix/pull/598 started to explain the values of the historical capacity and activity more detailed. However, as stated in comment https://github.com/iiasa/message_ix/pull/598#pullrequestreview-962906701 by @khaeru

... it's still unclear if/what the effect are of values for these parameters defined 2 or more periods before the first model year.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading pull request #598 and the linked review comment to understand which historical capacity and activity values are already documented. Determine and document the effect of values defined two or more periods before the first model year, with the completed documentation resolving the stated ambiguity.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.