Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Issue 408 Update Readme #410

Merged
merged 2 commits into from
Mar 22, 2022
Merged

Issue 408 Update Readme #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
556f5c6
Update README.md
dhblum Mar 22, 2022
dfea7d0
Update releasenotes.md
dhblum Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,18 @@ Example RESTful interaction:

| Interaction | Request |
|-----------------------------------------------------------------------|-----------------------------------------------------------|
| Advance simulation with control input and receive measurements. | POST ``advance`` with json data "{<input_name>:<value>}" |
| Initialize simulation to a start time using a warmup period in seconds. | PUT ``initialize`` with arguments ``start_time=<value>``, ``warmup_time=<value>``|
| Advance simulation with control input and receive measurements. | POST ``advance`` with optional json data "{<input_name>:<value>}" |
| 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=<value>``, ``warmup_period=<value>``|
| Receive communication step in seconds. | GET ``step`` |
| Set communication step in seconds. | PUT ``step`` with argument ``step=<value>`` |
| Set communication step in seconds. | PUT ``step`` with required argument ``step=<value>`` |
| 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=<string>``, ``start_time=<value>``, ``final_time=<value>``|
| Receive test result data for the given point name between the start and final time in seconds. | PUT ``results`` with required arguments ``point_name=<string>``, ``start_time=<value>``, ``final_time=<value>``|
| 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=<value>``, ``interval=<value>``|
| Set boundary condition forecast parameters in seconds. | PUT ``forecast_parameters`` with required arguments ``horizon=<value>``, ``interval=<value>``|
| 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=<string>``, ``time_period=<string>``. 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`` |
Expand Down
3 changes: 3 additions & 0 deletions releasenotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down