iiasa / message_ix

The integrated assessment and energy systems model MESSAGEix
https://docs.messageix.org
Apache License 2.0
111 stars 149 forks source link

Dac tutorial message models #807

Closed gidden closed 3 months ago

gidden commented 3 months ago

This is a fresh PR where we will implement DACCS related tutorials. It depends on https://github.com/iiasa/message-ix-models/pull/158 where additional features for implementing DACCS in scenarios are developed.

This supercedes #793 and #806

FYI @ywpratama

Required: write a single sentence that describes the changes made by this PR.

How to review

Required: describe specific things that reviewer(s) must do, in order to ensure that the PR achieves its goal. If no review is required, write “No review:” and describe why.

PR checklist

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.4%. Comparing base (99422f4) to head (f04e68a). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #807 +/- ## ===================================== Coverage 95.4% 95.4% ===================================== Files 46 46 Lines 4351 4351 ===================================== Hits 4153 4153 Misses 198 198 ``` | [Files](https://app.codecov.io/gh/iiasa/message_ix/pull/807?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa) | Coverage Δ | | |---|---|---| | [message\_ix/util/tutorial.py](https://app.codecov.io/gh/iiasa/message_ix/pull/807?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa#diff-bWVzc2FnZV9peC91dGlsL3R1dG9yaWFsLnB5) | `100.0% <100.0%> (ø)` | |
glatterf42 commented 3 months ago

Thanks for keeping this work up-to-date, @gidden :) However, I'm not sure we should be adding tutorials here that depend on code in message-ix-models. AFAIK, code in message-ix-models can rely on code in message_ix, but not the other way round. In theory, message_ix is a general tool and message-ix-models is about a specific application. @khaeru please correct me if I'm wrong.

khaeru commented 3 months ago

AFAIK, code in message-ix-models can rely on code in message_ix, but not the other way round. In theory, message_ix is a general tool and message-ix-models is about a specific application.

Yes, that's the order of our stack.

I do acknowledge that we have already a nice, inviting landing location in message-ix for new tutorials: there's a docs page, tests, etc. In message-ix-models, there are as yet no tutorials, so we lack corresponding items. However, we can pretty easily set that up by reusing or copying bits from message-ix. It would be great to have this as the first message-ix-models-specific tutorial.

gidden commented 3 months ago

Thanks both - would it be possible to get the skeleton of the docs pages in message-ix models and then we can add these there?

gidden commented 3 months ago

Hi all - after further discussions with @ywpratma we decided to make his add_dac tool more generic and will open a different PR for that