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 add tech #810

Open gidden opened 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

Attention: Patch coverage is 0.58480% with 170 lines in your changes are missing coverage. Please review.

Project coverage is 91.8%. Comparing base (27cd54e) to head (96c5cd1).

:exclamation: Current head 96c5cd1 differs from pull request most recent head 67181b2. Consider uploading reports for the commit 67181b2 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #810 +/- ## ======================================= - Coverage 95.4% 91.8% -3.6% ======================================= Files 46 47 +1 Lines 4354 4524 +170 ======================================= Hits 4156 4156 - Misses 198 368 +170 ``` | [Files](https://app.codecov.io/gh/iiasa/message_ix/pull/810?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/810?src=pr&el=tree&filepath=message_ix%2Futil%2Ftutorial.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa#diff-bWVzc2FnZV9peC91dGlsL3R1dG9yaWFsLnB5) | `100.0% <100.0%> (ø)` | | | [message\_ix/tools/add\_tech/\_\_init\_\_.py](https://app.codecov.io/gh/iiasa/message_ix/pull/810?src=pr&el=tree&filepath=message_ix%2Ftools%2Fadd_tech%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa#diff-bWVzc2FnZV9peC90b29scy9hZGRfdGVjaC9fX2luaXRfXy5weQ==) | `0.0% <0.0%> (ø)` | |
glatterf42 commented 3 months ago

Hi @gidden, please clarify for me: I thought we wanted to have the tutorials be part of message-ix-models. Was this decision revised? Should I still set up a docs page etc for tutorials in message-ix-models?

gidden commented 3 months ago

Hey @glatterf42 - good questions. Yes, in reviewing this PR and related work with @ywpratama yesterday, we realized that his add_dac() functionality was more generic and could be applied at a high level repo (similar to add_years() here). That is at least the proposal for now, which we can discuss once the PR is finalized.

So in short, no need to add tutorials page yet to message-ix-models

gidden commented 1 month ago

@glatterf42 and @ywpratama - this PR now has the content added to it that is expected. It would be useful if the two of you could sit down and discuss how to best add relevant tests for this so it can be merged.

@ywpratama there should be already available documentation for how to pass the code quality checks