ibpsa / project1-boptest

Building Optimization Performance Tests

Other

104 stars 69 forks source link

Update Introduction_to_the_BOPTEST_framework notebook #510

Closed jmythms closed 1 year ago

jmythms commented 1 year ago

Updated Introduction_to_the_BOPTEST_framework notebook to work with BOPTEST v0.3.0, attempting to fix #507 . Major changes:

Changed BOPTEST API base URL to http://api.boptest.net.
Changed the API calls to get info from 'payload'.
Added new KPIs.
Heat pump modulation signal is no longer in the measurements for bestest_hydronic_heat_pump so it was changed to the heat pump electrical power.
Added stop call at the end of the notebook.

jmythms commented 1 year ago

Converted to draft. Will pull in #508 after it is merged.

dhblum commented 1 year ago

508 is merged.

dhblum commented 1 year ago

This should not pull in #508 as that would make it incompatible with BOPTEST v0.3.0. I suggest keeping it compatible with v0.3.0 since that is what Service uses and this tutorial is based on use of Service. This and the version in Service should ideally stay updated together.

EDIT/Clarification: By "This should not pull in #508" I mean the example /forecast API usage in the tutorial should stay consistent with v0.3.0 as this is what Service currently uses.

dhblum commented 1 year ago

@jmythms Thanks for your updates. A couple of additional edits from me:

I reverted back to plotting the heat pump control signal (the way to get it changed from v0.1.0 to v0.3.0) for consistency with the older version of the tutorial and also to show how the control signal data can be retrieved.
I also made a bunch of text edits per updates we've made (especially linking to the website resources) since v0.1.0.
Merged latest master.

The original tutorial was linked as a colab notebook, which is nice so users can simply run from a web browser. This PR changes this to a simple ipython notebook. I've uploaded the most recent versioin to my colab account. @JavierArroyoBastida Any advice on how to link to this colab notebook? The summary Todo is:

[x] Link notebook for use with colab

Also Todo is:

[x] Update the provided pdf once all is said and done.
[x] Update release notes.

jmythms commented 1 year ago

@dhblum Sorry for letting this PR go a bit stale.

I think one way to make this a colab notebook would be to commit this file directly from your Google Colab account:

After opening the file in your colab account, go to File -> Save a copy in GitHub:
Put in the correct details for Repo, branch, file path, and commit message (optional):

dhblum commented 1 year ago

Thanks @jmythms! Looks like it worked to connect the colab.

dhblum commented 1 year ago

I believe this is ready to merge once tests pass.