Skip to content

Commit 9e65abc

Browse files
committed
Add iiasa#808 to docs, release notes
1 parent c381f24 commit 9e65abc

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

RELEASE_NOTES.rst

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ All changes
1414
- Support for Python 3.8 is dropped (:pull:`881`), as it has reached end-of-life.
1515
- Add :meth:`.Reporter.add_sankey` and :mod:`.tools.sankey` to create Sankey diagrams from solved scenarios (:pull:`770`).
1616
The :file:`westeros_sankey.ipynb` :ref:`tutorial <tutorial-westeros>` shows how to use this feature.
17+
- Add the :py:`concurrent=...` model option to :class:`.MACRO` (:pull:`808`).
1718
- Add option to :func:`.util.copy_model` from a non-default location of model files (:pull:`877`).
1819

1920
.. _v3.9.0:

doc/api.rst

+8
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,14 @@ Model classes
260260
:exclude-members: items
261261
:show-inheritance:
262262

263+
The MACRO class solves only the MACRO model in “standalone” mode—that is, without MESSAGE.
264+
It is also invoked from :class:`.MESSAGE_MACRO` to process *model_options* to control the behaviour of MACRO:
265+
266+
- **concurrent** (:class:`int` or :class:`float`, either :py:`0` or :py:`1`).
267+
This corresponds to the GAMS compile-time variable ``MACRO_CONCURRENT``.
268+
If set to :py:`0` (the default), MACRO is solved in a loop, once for each node in the Scenario.
269+
If set to :py:`1`, MACRO is solved only once, for all nodes simultaneously.
270+
263271
.. autoattribute:: items
264272
:no-value:
265273

0 commit comments

Comments
 (0)