From 556f5c69fe1e6ea2ef67055a3040c7eb342e1261 Mon Sep 17 00:00:00 2001 From: David Blum Date: Tue, 22 Mar 2022 12:34:09 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2682ff7af..1489b75b1 100644 --- a/README.md +++ b/README.md @@ -61,18 +61,18 @@ Example RESTful interaction: | Interaction | Request | |-----------------------------------------------------------------------|-----------------------------------------------------------| -| Advance simulation with control input and receive measurements. | POST ``advance`` with json data "{:}" | -| Initialize simulation to a start time using a warmup period in seconds. | PUT ``initialize`` with arguments ``start_time=``, ``warmup_time=``| +| Advance simulation with control input and receive measurements. | POST ``advance`` with optional json data "{:}" | +| Initialize simulation to a start time using a warmup period in seconds. Also resets point data history and KPI calculations. | PUT ``initialize`` with required arguments ``start_time=``, ``warmup_period=``| | Receive communication step in seconds. | GET ``step`` | -| Set communication step in seconds. | PUT ``step`` with argument ``step=`` | +| Set communication step in seconds. | PUT ``step`` with required argument ``step=`` | | Receive sensor signal point names (y) and metadata. | GET ``measurements`` | | Receive control signal point names (u) and metadata. | GET ``inputs`` | -| Receive test result data for the given point name between the start and final time in seconds. | PUT ``results`` with arguments ``point_name=``, ``start_time=``, ``final_time=``| +| Receive test result data for the given point name between the start and final time in seconds. | PUT ``results`` with required arguments ``point_name=``, ``start_time=``, ``final_time=``| | Receive test KPIs. | GET ``kpi`` | | Receive test case name. | GET ``name`` | | Receive boundary condition forecast from current communication step. | GET ``forecast`` | | Receive boundary condition forecast parameters in seconds. | GET ``forecast_parameters`` | -| Set boundary condition forecast parameters in seconds. | PUT ``forecast_parameters`` with arguments ``horizon=``, ``interval=``| +| Set boundary condition forecast parameters in seconds. | PUT ``forecast_parameters`` with required arguments ``horizon=``, ``interval=``| | Receive current test scenario. | GET ``scenario`` | | Set test scenario. Setting the argument ``time_period`` performs an initialization with predefined start time and warmup period and will only simulate for predefined duration. | PUT ``scenario`` with optional arguments ``electricity_price=``, ``time_period=``. See README in [/testcases](https://github.com/ibpsa/project1-boptest/tree/master/testcases) for options and test case documentation for details.| | Receive BOPTEST version. | GET ``version`` | From dfea7d079465c81c65241cd1e69ec23390d1188a Mon Sep 17 00:00:00 2001 From: David Blum Date: Tue, 22 Mar 2022 12:38:17 -0400 Subject: [PATCH 2/2] Update releasenotes.md --- releasenotes.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/releasenotes.md b/releasenotes.md index 8d3a08160..7c232d9ce 100644 --- a/releasenotes.md +++ b/releasenotes.md @@ -4,6 +4,9 @@ Released on xx/xx/xxxx. +**The following changes are backwards-compatible and do not significantly change benchmark results:** + +- Fix and clarify ``README.md`` for the ``/initialize`` and other API end points. This is for [#408](https://github.com/ibpsa/project1-boptest/issues/408). ## BOPTEST v0.2.0