diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index c3a66e78a..380a7173a 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -1,8 +1,24 @@ +.. _v3.10.0: + Next release ============ -GitHub community guidelines ---------------------------- +Migration note +--------------- + +.. _v3.10.0-migrate-1: + +1. For scenarios with :doc:`periods ` that have 2 or more different ``duration_period``, users should expect that values for the solution variable ``PRICE_EMISSION`` will change compared to version 3.9.0 and earlier. + + **Only** such scenarios are affected. + For example, if ``duration_period`` is 5 years for some periods in the ``year`` set, and 10 years for others, then ``PRICE_EMISSION`` values will change. + On the other hand, if ``duration_period`` values are *all* 5 years, or 10 years, there should be no change. + + This is a result of :pull:`912`, which adjusts the calculation of ``PRICE_EMISSION`` to give correct outcomes in the mixed-duration case. + Please refer to :pull:`726` and :pull:`723` for more extensive discussion of the issue and fix. + +GitHub-recommended community guidelines +--------------------------------------- Add community guidelines for interaction on GitHub (:pull:`871`, :pull:`911`). Please familiarize yourself with these to foster an open and welcoming community! @@ -15,6 +31,8 @@ All changes - 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 option to :func:`.util.copy_model` from a non-default location of model files (:pull:`877`). +- Bug fix for calculation of ``PRICE_EMISSION`` (:pull:`912`, :issue:`723`). + See the :ref:`migration note ` above. .. _v3.9.0: