From 69a6d402c5dae07487fc520bd06b52583370efb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roger=20Sams=C3=B3?= Date: Mon, 3 Jul 2023 11:31:26 +0200 Subject: [PATCH] update what's new --- docs/advanced_usage.rst | 2 ++ docs/whats_new.rst | 30 ++++++++++++++++++++++++++++++ pysd/_version.py | 2 +- 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst index 6f6b0e9d..df406743 100644 --- a/docs/advanced_usage.rst +++ b/docs/advanced_usage.rst @@ -9,6 +9,8 @@ Running models one (or more) step(s) at a time Coupling different models requires the exchange of certain variables between them. This is only possible if a stepping mechanism is available, which allows for running any number of steps with certain boundary conditions that evolve along time. In this section, we show how the teacup model may be run in a for loop using the :py:meth:`.step` function (rather than the :py:meth:`.run` function) and update the value of a model variable before each step:: + from pysd.py_backend.output import ModelOutput + # instantiate ModelOutput object output = ModelOutput() diff --git a/docs/whats_new.rst b/docs/whats_new.rst index 6489430e..afd07970 100644 --- a/docs/whats_new.rst +++ b/docs/whats_new.rst @@ -1,5 +1,35 @@ What's New ========== +v3.11.0 (2023/07) +----------------- +New Features +~~~~~~~~~~~~ +- Add the possibility to run a model one or several steps at a time, updating model variables in the process. (`@rogersamso `_) + +Breaking changes +~~~~~~~~~~~~~~~~ + +Deprecations +~~~~~~~~~~~~ + +Bug fixes +~~~~~~~~~ + +Documentation +~~~~~~~~~~~~~ +- Add the `Running models one (or more) step(s) at a time` section in :doc:`advanced_usage`. (`@rogersamso `_) + +Performance +~~~~~~~~~~~ + +Internal Changes +~~~~~~~~~~~~~~~~ +- Modify signature of the :py:class:`pysd.py_backend.output.ModelOutput` class. It now only accepts the path of the results file (`@rogersamso `_) +- Add the :py:meth:`pysd.py_backend.output.ModelOutput.collect` method to the :py:class:`pysd.py_backend.output.ModelOutput` class. (`@rogersamso `_) +- Add the :py:meth:`pysd.py_backend.model.Model.set_stepper` and :py:meth:`pysd.py_backend.model.Model.step` methods to the :py:class:`pysd.py_backend.model.Model` class. (`@rogersamso `_) +- Add several internal methods to the :py:class:`pysd.py_backend.model.Model` class, to avoid code repetition. (`@rogersamso `_) + + v3.10.0 (2023/04/28) -------------------- New Features diff --git a/pysd/_version.py b/pysd/_version.py index 9ce9954c..fcbd6954 100644 --- a/pysd/_version.py +++ b/pysd/_version.py @@ -1 +1 @@ -__version__ = "3.10.0" +__version__ = "3.11.0"