Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Improve handling of forecast variables #356

Closed
dhblum opened this issue Sep 3, 2021 · 2 comments
Closed

Improve handling of forecast variables #356

dhblum opened this issue Sep 3, 2021 · 2 comments
Assignees
Milestone

Comments

@dhblum
Copy link
Collaborator

dhblum commented Sep 3, 2021

Currently, GET /forecast returns all data for all forecast variables, which for large data sets leads to a hit on memory and computational time. There is also no documentation in the test cases of which forecast variables are available. This issue is to propose the following improvements:

  • Treat getting of forecast data similarly to /results. That is, add an argument that requires specification of the variable wanting to be forecasted and return data for that variable only. One even more backwards-incompatible thought could be to remove the /forecast_parameters API endpoint and replace with parameters horizon and interval upon retrieving a forecast for a particular variable. These changes combined would then change the forecast API endpoint to resemble the PUT /results API very closely as PUT /forecast with arguments point_name=<string>, horizon=<value>, interval=<value>.
  • Have a mechanism to add descriptions and units to forecast variables (perhaps another json included in the test case FMU), include these in a documentation section of test cases (similar to control inputs and measurements), and implement a GET /forecast_variables acting similarly to GET /inputs and GET /measurements to retrieve this information programatically.
@dhblum dhblum added this to the v1.0.0 milestone Aug 5, 2022
@dhblum dhblum self-assigned this Aug 5, 2022
@dhblum
Copy link
Collaborator Author

dhblum commented Aug 25, 2022

Initial implementation at https://github.com/ibpsa/project1-boptest/tree/issue356_forecastPoints. Still needs:

  • Update error handling
  • Update documentation for twozone_apartment_hydronic test case to include forecast points
  • Add/update unit tests
  • Update release notes
  • Update readme
  • Review

@dhblum
Copy link
Collaborator Author

dhblum commented Dec 1, 2022

Closed by #508.

mattrobmattrob added a commit to henze-research-group/MODRLC that referenced this issue Feb 16, 2024
Handle ibpsa/project1-boptest#508 and ibpsa/project1-boptest#356.

Default parameters previously from an example RLC simulation on MODRLC:
```
Default Forecast Interval:	3600.0
Default Forecast Horizon:	86400.0
```

Example parameters from BOPTEST codebase:

https://github.com/ibpsa/project1-boptest/blob/2b4328c1607f80a35890968fcac54d7d6c60b965/forecast/forecaster.py#L33-L35

Work towards #51.

Signed-off-by: Matt Robinson <mattrob@hey.com>
mattrobmattrob added a commit to henze-research-group/MODRLC that referenced this issue Feb 23, 2024
Handle ibpsa/project1-boptest#508 and ibpsa/project1-boptest#356.

Default parameters previously from an example RLC simulation on MODRLC:
```
Default Forecast Interval:	3600.0
Default Forecast Horizon:	86400.0
```

Example parameters from BOPTEST codebase:

https://github.com/ibpsa/project1-boptest/blob/2b4328c1607f80a35890968fcac54d7d6c60b965/forecast/forecaster.py#L33-L35

Work towards #51.

Signed-off-by: Matt Robinson <mattrob@hey.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant