Add T into the BMT workflows and update MACRO for BMT

doc/api/model-bmt.rst

@@ -8,6 +8,19 @@ that combines all 3 of the
 :doc:`MESSAGEix-Transport </transport/index>` (**T**)
 model variants.
 
+In :func:`.bmt.workflow.generate`, each variant is added as follows:
+
+- **Materials (M)** — load a baseline that already includes MESSAGEix-Materials
+  (step ``M``); there is no separate materials build step yet.
+- **Transport (T)** — build MESSAGEix-Transport on the cloned materials scenario
+  via :func:`.transport.workflow.add_steps` and :func:`.transport.build.main`,
+  using the ``transport`` section of :file:`data/bmt/config.yaml``.
+- **Buildings (B)** — in step ``BMT built``, call :func:`.buildings.build.main`
+  (imported in :mod:`.bmt.workflow` as ``build_B``) on the ``MT solved`` scenario.
+- **Other BMT extensions** — add power-sector material intensity with
+  :func:`.bmt.utils.build_PM` (``BMTX built``); later steps prepare MACRO
+  calibration and solve with MESSAGE-MACRO.
+
 The current module :mod:`.model.bmt` includes:
 
 - :func:`.bmt.workflow.generate` —generates a :class:`.Workflow`
@@ -17,7 +30,7 @@ The current module :mod:`.model.bmt` includes:
   used to invoke the workflow.
   For example::
 
-    mix-models bmt run --from="base" "glasgow+" --dry-run
+    mix-models bmt run --from="base" "BMTX baseline macro reported" --dry-run
 
   See :program:`mix-models bmt run --help` for options.
 - :mod:`.bmt.config` —handling for configuration,

doc/api/report/index.rst

@@ -211,6 +211,7 @@ Operators
       node_glb
       nodes_world_agg
       remove_ts
+      remove_zeros
       select_allow_empty
       select_expand
       share_curtailment

doc/whatsnew.rst

@@ -7,7 +7,7 @@ Next release
 - Add IAMC code list :class:`~.iamc.structure.CL_SCENARIO_DIAGNOSTIC` (:pull:`501`).
 - New module :ref:`tools-newclimate` (:pull:`499`).
 - Add :class:`.model.water.Config` to collect water module settings (:pull:`509`).
-- Add :doc:`/api/model-bmt` (:pull:`433`).
+- Add :doc:`/api/model-bmt` (:pull:`433`, :pull:`486`).
 
   - Add
     :data:`.buildings.config.DEFAULT_DATA_PATHS`,

message_ix_models/cli.py

@@ -158,8 +158,10 @@ def _log_threads(k: int, n: int):
 #: Each of these should contain a function named ``cli`` decorated with @click.command
 #: or @click.group.
 submodules = [
+    "message_ix_models.model.bmt.cli",
     "message_ix_models.model.buildings.cli",
     "message_ix_models.model.cli",
+    "message_ix_models.model.material.cli",
     "message_ix_models.model.structure",
     "message_ix_models.model.transport.cli",
     "message_ix_models.model.water.cli",
@@ -168,11 +170,9 @@ def _log_threads(k: int, n: int):
     "message_ix_models.project.navigate.cli",
     "message_ix_models.project.ssp.cli",
     "message_ix_models.report.cli",
-    "message_ix_models.model.material.cli",
     "message_ix_models.testing.cli",
     "message_ix_models.util.pooch",
     "message_ix_models.util.slurm",
-    "message_ix_models.model.bmt.cli",
 ]
 
 try:

message_ix_models/data/bmt/config.yaml

@@ -1,17 +1,28 @@
-# BMT workflow configuration.
-# Top-level keys are energy demand sectors; each is loaded into context (e.g. context.buildings).
-# Paths under a sector are relative to private_data_path(sector) unless redefined.
+# BMT workflow configuration
+
+# Top-level keys: model_name, buildings, macro, transport, …
+# apply_bmt_config sets context.bmt (full dict), context.buildings, context.macro,
+# and context.transport (MESSAGEix-Transport Config from the transport section).
+
+model_name: "MESSAGEix-GLOBIOM-GAINS 2.1-BMT-R12"
 
 buildings:
+  # An ID from CL_SCENARIO_CIRCEULAR, e.g. "R" for "Reference"
+  code: "R"
   data_paths:
       # Input file names under private_data_path("buildings")
       prices: "input_prices_R12.csv"
-      sturm_r: "report_MESSAGE_resid_SSP2_nopol_post.csv"
-      sturm_c: "report_MESSAGE_comm_SSP2_nopol_post.csv"
-      demand_static: "static_20251227.csv"
+      sturm_r: "resid_sturm_aligned_R.csv"
+      sturm_c: "comm_sturm_aligned_R.csv"
+      demand_static: "resid_comm_glance_aligned_R.csv"
   # Whether to include materials (steel, cement, aluminum) in the buildings spec
-  with_materials: true
+  with_materials: False
+
+macro: "macro_calibration_input_SSP2_bmt.xlsx"
+
+transport:
+  # Scenario code id from the transport SDMX codelist
+  code: "SSP2" # or "M SSP2"
 
-# transport: {}
 # materials: {}
 # others: {}

message_ix_models/data/buildings/commodity.yaml

@@ -65,7 +65,6 @@ comm_hotwater_gas:
   description: Gas demand for commercial hotwater
 
 # loil_rc
-resid_cook_lightoil:
 resid_cook_lightoil:
   description: Light oil demand for residential cooking
 resid_hotwater_lightoil:

message_ix_models/model/bmt/config.py

@@ -1,21 +1,4 @@
-"""BMT workflow configuration.
-
-This module loads a file :file:`data/bmt/config.yaml`. This YAML file has top-level
-keys:
-
-.. code-block:: yaml
-
-   buildings:
-      # ...
-   materials:
-      # ...
-   transport:
-      # ...
-
-Of these, only the first is currently required; the latter two are omitted. The function
-:func:`_load_yaml` reads each section and passes it to the corresponding
-:class:`.Context` key, for instance :py:`Context.buildings`.
-"""
+"""BMT workflow configuration."""
 
 from typing import TYPE_CHECKING
 
@@ -24,22 +7,68 @@
 if TYPE_CHECKING:
     from pathlib import Path
 
-    from message_ix_models.model.buildings import Config
+    from message_ix_models.util.context import Context
+
+
+def apply_bmt_config(context: "Context", path: "Path | None" = None) -> None:
+    """Load BMT configuration file into `context` (bmt, buildings, macro, transport).
+
+    The file given by `path` **must** be in YAML format and have the top-level keys:
 
+    .. code-block:: yaml
 
-def load_buildings_config(path: "Path | None" = None) -> "Config":
-    """Load the ``buildings`` section from :file:`data/bmt/config.yaml` for
-    :attr:`context.buildings`.
+       model_name: "..."
+       buildings:
+          # ...
+       macro: "..."
+       materials:  # Optional
+          # ...
+       transport:  # Optional
+          # ...
 
-    Missing keys in the ``buildings`` section are filled from
-    :data:`BUILDINGS_DEFAULTS`. If the section is missing, all defaults are used.
+    All data from the file is stored at the key :py:`context.bmt` as a :class:`dict`.
+    The function then sets or converts other values:
+
+    - :attr:`context.buildings`: an instance of :class:`~.buildings.config.Config`
+      (including :attr:`.Config.data_paths`, :attr`~code`` for STURM, etc.) from the
+      ``buildings`` mapping.
+    - :attr:`context.macro`: ``macro`` string (macro calibration workbook).
+    - :attr:`context.transport`: and instance of :class:`transport.config.Config` using
+      :meth:`~.transport.config.Config.from_context`, with the YAML ``transport``
+      mapping passed as `options` (e.g. ``code: "M SSP2"``).
+
+      .. note:: The :py:`context.transport` key must be an instance of that class,
+         because :mod:`.model.transport` code expects its various attributes.
+
+    Parameters
+    ----------
+    path :
+        Configuration file path. If not given, defaults to :file:`data/bmt/config.yaml`.
+        This file **must** be in YAML format has top-leve
     """
-    from message_ix_models.model.buildings.config import METHOD, Config
+    import yaml
+
+    from message_ix_models.model.buildings.config import METHOD
+    from message_ix_models.model.buildings.config import Config as BuildingsConfig
+    from message_ix_models.model.transport.config import Config as TransportConfig
+
+    p = path or package_data_path("bmt", "config.yaml")
 
     # Create a buildings Config
-    result = Config(sturm_scenario="NONE", method=METHOD.B)
+    result = BuildingsConfig(sturm_scenario="NONE", method=METHOD.B)
+    context.buildings = result
 
     # Update from the "buildings:" key in the YAML file
-    result.read_file(path or package_data_path("bmt", "config.yaml"), key="buildings")
+    result.read_file(p, key="buildings")
+
+    # Read the entire file
+    with open(p) as f:
+        data = yaml.safe_load(f) or {}
+
+    # Store data, MACRO data directly on `context`
+    context.bmt = data
+    context.macro = data.get("macro")
 
-    return result
+    # Create a .transport.Config object, overriding defaults with values from the
+    # "transport:" key in the file
+    TransportConfig.from_context(context, options=data.get("transport", {}))