Connect MACRO explicitly to MESSAGEix Scenarios

RELEASE_NOTES.rst

@@ -6,6 +6,7 @@ All changes
 
 - `#313 <https://github.com/iiasa/ixmp/pull/313>`_: Include all tests in the message_ix package.
 - `#307 <https://github.com/iiasa/message_ix/pull/307>`_: adjust to deprecations in ixmp 2.0.
+- `#223 <https://github.com/iiasa/message_ix/pull/223>`_: Add methods for parametrization and calibration of MACRO based on an existing MESSAGE Scenario.
 
 
 v2.0.0 (2020-01-14)

message_ix/__init__.py

@@ -5,10 +5,11 @@
 from ixmp.model import MODELS
 
 from .core import Scenario  # noqa: F401
-from .models import MESSAGE, MESSAGE_MACRO
+from .models import MACRO, MESSAGE, MESSAGE_MACRO
 
 
 __all__ = [
+    'MACRO',
     'MESSAGE',
     'MESSAGE_MACRO',
     'MODELS',
@@ -21,6 +22,7 @@
 
 
 # Register models with ixmp core
+MODELS['MACRO'] = MACRO
 MODELS['MESSAGE'] = MESSAGE
 MODELS['MESSAGE-MACRO'] = MESSAGE_MACRO
 

message_ix/core.py

@@ -1,12 +1,21 @@
 import collections
 from functools import lru_cache
 from itertools import product
+import logging
 
 import ixmp
 from ixmp.utils import as_str_list, pd_read, pd_write, isscalar, logger
 import pandas as pd
 
 
+log = logging.getLogger(__name__)
+
+# Also print warnings to stderr
+_sh = logging.StreamHandler()
+_sh.setLevel(level=logging.WARNING)
+log.addHandler(_sh)
+
+
 class Scenario(ixmp.Scenario):
     """|MESSAGEix| Scenario.
 
@@ -427,6 +436,26 @@ def solve(self, model='MESSAGE', solve_options={}, **kwargs):
         """
         super().solve(model=model, solve_options=solve_options, **kwargs)
 
+    def add_macro(self, data, scenario=None, check_convergence=True, **kwargs):
+        # TODO document
+        from .macro import EXPERIMENTAL, add_model_data, calibrate
+        from .models import MACRO
+
+        # Display a warning
+        log.warning(EXPERIMENTAL)
+
+        scenario = scenario or '_'.join([self.scenario, 'macro'])
+        clone = self.clone(self.model, scenario, keep_solution=False)
+        clone.check_out()
+
+        # Add ixmp items: sets, parameters, variables, and equations
+        MACRO.initialize(clone)
+
+        add_model_data(self, clone, data)
+        clone.commit('finished adding macro')
+        calibrate(clone, check_convergence=check_convergence, **kwargs)
+        return clone
+
     def rename(self, name, mapping, keep=False):
         """Rename an element in a set