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

Use ScheduleDay::timeSeries in schedule_day_get_hourly_values #1788

Merged
merged 11 commits into from
Aug 8, 2024

Conversation

eringold
Copy link
Collaborator

@eringold eringold commented Aug 7, 2024

Pull request overview

OpenStudio 3.8.0 introduced the ScheduleDay::timeSeries SDK method, which speeds up the schedule_day_get_hourly_values method considerably. This PR implements it, most cricially in the widely-used spaces_get_occupancy_schedule.

Benchmarked against the 0.4.0 version of Standard.spaces_get_occupancy_schedule for four test models, this method shows between a ~30-60% speedup:
image

Pull Request Author

  • Method changes or additions
  • Data changes or additions
  • Added tests for added methods
  • If methods have been deprecated, update rest of code to use the new methods
  • Documented new methods using yard syntax
  • Resolved yard documentation errors for new code (ran bundle exec rake doc)
  • Resolved rubocop syntax errors for new code (ran bundle exec rake rubocop)
  • All new and existing tests passes
  • If the code adds new require statements, ensure these are in core ruby or add to the gemspec

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a code review on GitHub
  • All related changes have been implemented: method additions, changes, tests
  • Check rubocop errors
  • Check yard doc errors
  • If fixing a defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If a new feature, test the new feature and try creative ways to break it
  • CI status: all green or justified

@eringold eringold requested a review from mdahlhausen August 7, 2024 18:53
@mdahlhausen mdahlhausen merged commit 0aaf55f into master Aug 8, 2024
@mdahlhausen mdahlhausen deleted the use_scheduleday_timeseries branch August 8, 2024 15:17
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

Successfully merging this pull request may close these issues.

2 participants