From 4f68514cce35e1380c4f4d0ecc552c0dd0df76ae Mon Sep 17 00:00:00 2001 From: Paul Natsuo Kishimoto Date: Mon, 20 Jan 2025 23:36:08 +0100 Subject: [PATCH] Add #808 to docs, release notes --- RELEASE_NOTES.rst | 1 + doc/api.rst | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index caa5774b6..1136c5c66 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -14,6 +14,7 @@ All changes - Support for Python 3.8 is dropped (:pull:`881`), as it has reached end-of-life. - Add :meth:`.Reporter.add_sankey` and :mod:`.tools.sankey` to create Sankey diagrams from solved scenarios (:pull:`770`). The :file:`westeros_sankey.ipynb` :ref:`tutorial ` shows how to use this feature. +- Add the :py:`concurrent=...` model option to :class:`.MACRO` (:pull:`808`). - Add option to :func:`.util.copy_model` from a non-default location of model files (:pull:`877`). .. _v3.9.0: diff --git a/doc/api.rst b/doc/api.rst index e17e468a6..659eb8325 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -260,6 +260,14 @@ Model classes :exclude-members: items :show-inheritance: + The MACRO class solves only the MACRO model in “standalone” mode—that is, without MESSAGE. + It is also invoked from :class:`.MESSAGE_MACRO` to process *model_options* to control the behaviour of MACRO: + + - **concurrent** (:class:`int` or :class:`float`, either :py:`0` or :py:`1`). + This corresponds to the GAMS compile-time variable ``MACRO_CONCURRENT``. + If set to :py:`0` (the default), MACRO is solved in a loop, once for each node in the Scenario. + If set to :py:`1`, MACRO is solved only once, for all nodes simultaneously. + .. autoattribute:: items :no-value: