ibpsa / project1-boptest

Building Optimization Performance Tests
Other
102 stars 66 forks source link

Missing model inputs for BESTEST Air #555

Closed Swopper050 closed 4 months ago

Swopper050 commented 1 year ago

I just discovered the package (awesome btw!) and I was running a little test with the BESTEST Air test case, however, it did not respond to my change in heating setpoint.

These are the four model inputs shown in the detailed description: The model inputs are:

However, when looking closer at the response, I also saw con_oveTSetHea_activate, which needed to be 1.0 in order for the model to respond to the change in setpoint.

Shouldn't these also be documented? Or did I miss them somewhere?

Same for:

dhblum commented 1 year ago

The need for using the associated activation signals is specified here in the README: https://github.com/ibpsa/project1-boptest#test-case-restful-api on the third bullet point under "Example RESTful interaction." I agree this has become buried too deep since early development when the README was simpler and the primary documentation piece. Thank you @Swopper050 for pointing out.

I suggest

dhblum commented 5 months ago

@EttoreZ Can you address this? I suggest updating https://github.com/ibpsa/project1-boptest/blob/master/data/get_html_IO.py to also write the input point <point_name>_activate for each input point, and a description "Activation signal to overwrite where 1 activates, 0 deactivates (default)". And then run that script for each test case to generate new docs.

EttoreZ commented 4 months ago

@dhblum I updated the get_html_IO.py script and all test cases documenations. The PR is ready for review.