message_ix icon indicating copy to clipboard operation
message_ix copied to clipboard

Dac tutorial add tech

Open gidden opened this issue 1 year ago • 5 comments

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

  • [ ] Continuous integration checks all ✅
  • [ ] Add or expand tests; coverage checks both ✅
  • [ ] Add, expand, or update documentation.
  • [ ] Update release notes.

gidden avatar Mar 28 '24 12:03 gidden

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
@@           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 Coverage Δ
message_ix/util/tutorial.py 100.0% <100.0%> (ø)
message_ix/tools/add_tech/__init__.py 0.0% <0.0%> (ø)

codecov[bot] avatar Mar 28 '24 12:03 codecov[bot]

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?

glatterf42 avatar Mar 29 '24 07:03 glatterf42

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 avatar Mar 29 '24 07:03 gidden

@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

gidden avatar May 08 '24 11:05 gidden