Skip to content

Manual adjustments for .engage.workflow migration #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
May 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/workflows/pytest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ name: Test

on:
# To debug the workflow, uncomment this entry AND comment pull_request_target
# pull_request:
# branches: [ main ]
pull_request_target:
pull_request:
branches: [ main, "migrate**" ]
types: [ labeled, opened, reopened, synchronize ]
# pull_request_target:
# branches: [ main, "migrate**" ]
# types: [ labeled, opened, reopened, synchronize ]
schedule:
- cron: "0 5 * * *" # = 06:00 CET = 07:00 CEST

Expand Down Expand Up @@ -193,6 +193,7 @@ jobs:
"dask < 2025.4.0" \
"ixmp @ git+https://github.com/iiasa/ixmp.git@${{ matrix.version.upstream }}" \
"message-ix @ git+https://github.com/iiasa/message_ix.git@${{ matrix.version.upstream }}" \
"message-ix-buildings @ git+https://github.com/iiasa/message-ix-buildings@main" \
.[docs,tests]

- name: Configure local data path
Expand Down
21 changes: 21 additions & 0 deletions doc/api/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,24 @@ World Bank structures (:mod:`.tools.wb`)

.. automodule:: message_ix_models.tools.wb
:members:


Tools for scenario manipulation
===============================

.. currentmodule:: message_ix_models.tools

.. autosummary::
:toctree: _autosummary
:template: autosummary-module.rst
:recursive:

add_AFOLU_CO2_accounting
add_CO2_emission_constraint
add_FFI_CO2_accounting
add_alternative_TCE_accounting
add_budget
add_emission_trajectory
add_tax_emission
remove_emission_bounds
update_h2_blending
6 changes: 4 additions & 2 deletions doc/model/buildings/index.rst → doc/buildings/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
MESSAGEix-Buildings
*******************

.. caution:: |gh-350|

MESSAGEix-Buildings refers to a set of models including a specific configuration of MESSAGEix-GLOBIOM.

Code is maintained in the `iiasa/MESSAGE_Buildings <https://github.com/iiasa/MESSAGE_Buildings>`_ repository.
Expand Down Expand Up @@ -181,13 +183,13 @@ Configuration
The class :class:`.buildings.Config` defines all the options to which the code responds, as well as default values.
Values given in code or on the command line will override these.

.. autoclass:: message_data.model.buildings.Config
.. autoclass:: message_ix_models.model.buildings.Config
:members:

Code reference
==============

.. currentmodule:: message_data.model
.. currentmodule:: message_ix_models.model

.. autosummary::
:toctree: _autosummary
Expand Down
6 changes: 6 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@
.. |y0| replace:: :math:`y_0`

.. |MESSAGEix| replace:: MESSAGE\ :emphasis:`ix`

.. |gh-350| replace::
This documentation and the related code was migrated from :mod:`message_data` ``dev``
branch as of commit 8213e6c (2025-05-08) in :pull:`350`.
It does not reflect further changes made on the :mod:`message_data` ``main`` branch,
other related branches, or in forks or other repositories.
Comment on lines +87 to +90
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is clear to me, but I might not be the best to judge this since I already understood this concept when I migrated the legacy reporting version.

"""


Expand Down
2 changes: 2 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
:caption: Model variants

global/index
buildings/index
material/index
transport/index
water/index
Expand All @@ -101,6 +102,7 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
project/ecemf
project/edits
project/elevate
project/engage
project/gea
project/geidco
project/genie
Expand Down
18 changes: 18 additions & 0 deletions doc/project/engage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
ENGAGE
******

- Project website: https://engage-climate.org

.. caution:: |gh-350|

Code reference
==============

.. currentmodule:: message_ix_models.project

.. autosummary::
:toctree: _autosummary
:template: autosummary-module.rst
:recursive:

engage
20 changes: 20 additions & 0 deletions doc/project/navigate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
NAVIGATE
********

“Next generation of AdVanced InteGrated Assessment modelling to support climaTE policy making”

- Project website: https://www.navigate-h2020.eu/about-the-project/structure/

.. caution:: |gh-350|

Code reference
==============

.. currentmodule:: message_ix_models.project

.. autosummary::
:toctree: _autosummary
:template: autosummary-module.rst
:recursive:

navigate
10 changes: 10 additions & 0 deletions doc/whatsnew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ Next release
:func:`.shape_test_data`,
:func:`.ssp_test_data`,
:func:`.ssp_user_data`.
- Migrate code, data, and documentation for :doc:`buildings/index`, :doc:`ENGAGE project <project/engage>`, :doc:`NAVIGATE project <project/navigate>`, and 9 :mod:`.tools` submodules (:pull:`350`, :pull:`351`):
:mod:`.add_AFOLU_CO2_accounting`,
:mod:`.add_CO2_emission_constraint`,
:mod:`.add_FFI_CO2_accounting`,
:mod:`.add_alternative_TCE_accounting`,
:mod:`.add_budget`,
:mod:`.add_emission_trajectory`,
:mod:`.add_tax_emission`,
:mod:`.remove_emission_bounds`, and
:mod:`.update_h2_blending`.
- Bug fix: :program:`mix-models --verbose` command-line option was not stored on :class:`.Context`/:class:`~.util.Config` (:pull:`300`).
- Bug fix: adjust or guard some Python usage that was not compatible with Python 3.9
—the earliest version supported by :mod:`message_ix_models` (:pull:`295`, :issue:`294`).
Expand Down
Loading
Loading