iiasa / iiasa/message_ix

Create a docs page about 'space'

Open
#848 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

@behnam-zakeri thanks for filling in on this model feature that I wasn't really aware of!

As an aside, I think this points to the need for a 'space' docs page parallel to https://docs.messageix.org/en/latest/time.html, to explain such topics.

Originally posted by @khaeru in https://github.com/iiasa/message_ix/discussions/845#discussioncomment-9645354

This comment was a reaction to a question about how to apply bound_emission to all nodes under a parent node. It would be useful to create a dedicated docs page for this, collecting the best way to handle regions, spatial hierarchy, etc, which this issue tracks.

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 the existing time.html page and the linked discussion 845 to understand the requested documentation style and context. Create a dedicated space page covering regions, spatial hierarchy, and applying bound_emission to nodes under a parent; done means these topics and recommended handling are explained clearly.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.