Migrate .engage.workflow and related tools

[khaeru]

Prompted by this issue (Slack link, non-public), this PR migrates two functions used in .transport.workflow.tax_emission():

• message_data.projects.engage.workflow.step_0()
• message_data.projects.navigate.workflow.tax_emission()

…along with the code on which these are dependent.

The files and Git history migrate from the message_data dev branch, which is the version that is currently used / known-to-work with message_ix_models.model.transport. Some of these files may have been changed on the message_data ssp_dev branch; those changes can later be merged into their new locations here.

Per our usual migration approach, the files were selected with the following:

BATCH = (
    dict(
        args=[
            # Filter some paths
            "--path=data/alps",
            "--path=data/buildings",
            "--path=data/tests/buildings",
            "--path=doc/model/buildings.rst",
            f"--path={S.base}/model/buildings/",
            f"--path-regex={S.base}/projects/navigate/(cli|report|workflow).py",
            f"--path={S.base}/projects/navigate/wp2",
            f"--path={S.base}/tests/model/test_buildings.py",
            f"--path={S.base}/tests/project/test_navigate.py",
            f"--path={S.base}/tests/project/navigate",
            f"--path={S.base}/tests/tools/test_utilities.py",
            f"--path={S.base}/tools/utilities/add_AFOLU_CO2_accounting.py",
            f"--path={S.base}/tools/utilities/add_CO2_emission_constraint.py",
            f"--path={S.base}/tools/utilities/add_FFI_CO2_accounting.py",
            f"--path={S.base}/tools/utilities/add_alternative_TCE_accounting.py",
            f"--path={S.base}/tools/utilities/add_budget.py",
            f"--path={S.base}/tools/utilities/add_emission_trajectory.py",
            f"--path={S.base}/tools/utilities/add_tax_emission.py",
            f"--path={S.base}/tools/utilities/remove_emission_bounds.py",
            f"--path={S.base}/tools/utilities/update_h2_blending.py",
            # Rename paths
            f"--path-rename=data:{T.base}/data",
            f"--path-rename=data/tests:{T.base}/data/test",
            "--path-rename=doc/model/buildings.rst:doc/model/buildings/index.rst",
            f"--path-rename={S.base}/tests/tools/test_utilities.py:{T.base}/tests/test_tools.py",
            f"--path-rename={S.base}/model:{T.base}/model",
            f"--path-rename={S.base}/projects:{T.base}/project",
            f"--path-rename={S.base}/tools/utilities:{T.base}/tools",
            f"--path-rename={S.base}/tests:{T.base}/tests",
            "--replace-message=../replacements.txt",
        ],
        message_callback=message_callback,
    ),
)

and the following in replacements.txt:

regex:([\( ])(#[0-9]+[\) ]?)==>\1iiasa/message_data\2
regex:^Updating==>Update

Next:

• I'll open a clean-up PR on the basis of this one → Manual adjustments for .engage.workflow migration #351.
• We'll complete and merge that into this branch.
• Then we'll take this out of draft state, approve, and merge.

How to review

• Review Manual adjustments for .engage.workflow migration #351.
• Confirm that CI checks pass once Manual adjustments for .engage.workflow migration #351 is merged into this branch.

PR checklist

• Continuous integration checks all ✅
• Add or expand tests; coverage checks both ✅
  • Some tests were added or re-enabled, but see Test NAVIGATE workflow pieces #352.
• Add, expand, or update documentation.
• Update doc/whatsnew.
• (After approval) Drop the TEMPORARY commit.

[codecov]

Codecov Report

Attention: Patch coverage is 61.28017% with 369 lines in your changes missing coverage. Please review.

Project coverage is 72.0%. Comparing base (7a999bc) to head (4bc1cfa).

Files with missing lines	Patch %	Lines
message_ix_models/project/navigate/workflow.py	46.4%	128 Missing ⚠️
message_ix_models/model/buildings/build.py	49.5%	58 Missing ⚠️
message_ix_models/model/buildings/rc_afofi.py	18.8%	43 Missing ⚠️
message_ix_models/project/navigate/report.py	28.8%	42 Missing ⚠️
message_ix_models/project/navigate/cli.py	32.0%	34 Missing ⚠️
message_ix_models/model/buildings/__init__.py	32.5%	27 Missing ⚠️
message_ix_models/model/buildings/report.py	33.3%	20 Missing ⚠️
message_ix_models/model/buildings/sturm.py	42.8%	4 Missing ⚠️
message_ix_models/tests/project/test_navigate.py	90.6%	3 Missing ⚠️
message_ix_models/project/navigate/wp2/util.py	98.0%	2 Missing ⚠️
... and 5 more

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #350     +/-   ##
=======================================
- Coverage   74.2%   72.0%   -2.3%     
=======================================
  Files        220     243     +23     
  Lines      17746   19451   +1705     
=======================================
+ Hits       13182   14011    +829     
- Misses      4564    5440    +876     

Files with missing lines	Coverage Δ
message_ix_models/cli.py	93.4% <ø> (ø)
message_ix_models/model/buildings/cli.py	72.7% <100.0%> (ø)
message_ix_models/project/navigate/__init__.py	100.0% <100.0%> (+32.5%)	⬆️
message_ix_models/testing/__init__.py	80.1% <ø> (-14.3%)	⬇️
..._ix_models/tests/project/navigate/test_wp2_util.py	100.0% <100.0%> (ø)
message_ix_models/tests/test_tools.py	73.7% <100.0%> (ø)
...age_ix_models/tools/add_CO2_emission_constraint.py	100.0% <100.0%> (ø)
..._ix_models/tools/add_alternative_TCE_accounting.py	97.0% <100.0%> (ø)
message_ix_models/tools/add_budget.py	100.0% <100.0%> (ø)
message_ix_models/tools/add_tax_emission.py	100.0% <100.0%> (ø)
... and 16 more

... and 9 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[khaeru]

Per the description, we expect the two coverage checks to fail on this PR:

• codecov/patch: only about 61% of the added/changed lines are covered.
• codecov/project: a drop of about 2.3% for the whole project.

I opened #352 for the work to add tests of this code. We will prioritize the pieces needed to make the NGFS BMT workflow operational.

[glatterf42]

This seems to have worked exactly as intended, judging from the passing tests and the adjusted test coverage :)