Merge pull request #683 from behnam-zakeri/tutorial-multinode-trade

Add a tutorial for creating Westeros multi-node and modeling different trade possibilities

RELEASE_NOTES.rst

@@ -42,6 +42,7 @@ Migration notes
 All changes
 -----------
 
+- Add a tutorial for Westeros multi-node and different trade possibilities (:pull:`683`).
 - Add additional oscillation detection mechanism for macro iterations (:pull:`645`, :pull:`676`)
 - Adjust default `lpmethod` from "Dual Simplex" (2) to "Barrier" (4); do NOT remove `cplex.opt` file(s) after solving workflow completes (:pull:`657`).
 - Adjust :meth:`.Scenario.add_macro` calculations for pandas 1.5.0 (:pull:`656`).

message_ix/tests/test_tutorials.py

@@ -55,6 +55,7 @@
     (("westeros", "westeros_soft_constraints"), [], {}),
     (("westeros", "westeros_addon_technologies"), [], {}),
     (("westeros", "westeros_historical_new_capacity"), [], {}),
+    (("westeros", "westeros_multinode"), [], {}),
     # NB this is the same value as in test_reporter()
     (("westeros", "westeros_report"), [("len-rep-graph", 13074)], {}),
     ((AT, "austria"), [("solve-objective-value", 206321.90625)], {}),

tutorial/README.rst

@@ -155,6 +155,9 @@ framework, such as used in global research applications of |MESSAGEix|.
    #. Use parameters to represent the historical characteristics of the energy
       system (:tut:`westeros/westeros_historical_new_capacity.ipynb`).
 
+   #. Modeling of a multi-node energy system and representing trade between nodes
+      (:tut:`westeros/westeros_multinode.ipynb`).
+
 #. Use other features of :mod:`message_ix` and :mod:`ixmp`:
 
    #. ⭐ After the MESSAGE model has solved, use the :mod:`.message_ix.reporting`