Provide a list of points to /results

ibpsa / project1-boptest

Building Optimization Performance Tests

Other

105 stars 69 forks source link

Provide a list of points to /results #398

Closed dhblum closed 2 years ago

dhblum commented 2 years ago

This issue is to suggest making the ability to provide a list of points to the /results API call, instead of requiring one at a time. The return would be the same object, just with additional arrays of point data.

While I acknowledge the potential memory issues of calling for large amounts of data (e.g. https://github.com/ibpsa/project1-boptest/issues/240), this would reduce the need for excessive network requests (say in a long for-loop), which could otherwise bottleneck the system. And, the user would have control over the amount of data returned at one time if memory becomes too much an issue.

dhblum commented 2 years ago

We may also consider similarly for forecast data when addressing https://github.com/ibpsa/project1-boptest/issues/356.

EttoreZ commented 2 years ago

@dhblum would you mind create the branch issue398_ListOfPointsResultsAPI so I can make a pull request? All the unit tests passed on bestest_air and bestest_hydronic. However, there are still a couple of things to check before the pull request is completely ready:

[x] Check that python examples run correctly
[x] Check that Juilia examples run correctly
[x] Make changes for Javascript examples
[x] Check comments and documentation

dhblum commented 2 years ago

Thanks @EttoreZ. Branch created here https://github.com/ibpsa/project1-boptest/tree/issue398_ListOfPointsResultsAPI. Make the PR and unit tests will check bullets 1 and 2. 3 shouldn't be too hard to add if I have to, and I can review comments/docs.

dhblum commented 2 years ago

Closed by https://github.com/ibpsa/project1-boptest/pull/480.