iiasa / iiasa/message_ix

Clarify add_macro() behaviour on a non-'clean' Scenario

Open
#320 6 comments 0 reactions 0 assignees View on GitHub
macro
Dominant language
Jupyter Notebook
Stars
150
Forks
178
Avg merge
17h 32m
Merged PRs (30d)
2

Description

In #223, there was a discussion (https://github.com/iiasa/message_ix/pull/223#discussion_r312356449) of how Scenario.add_macro should behave when the target Scenario already contains MACRO-related items or data; i.e. should it:
- refuse to proceed and raise an Exception,
- overwrite the existing content, or
- something else?

At minimum, a clear description of the behaviour is needed before this feature can be released with message_ix 3.0. Ideally, more thorough checks and informative messages would help users avoid errors.

Contributor guide

Open the contributing guide

Research direction

Start at the Scenario.add_macro entry point and review the discussion linked from issue #223. Decide and document how the method handles existing MACRO-related content, then define the checks and informative messages needed to make that behavior clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.