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

Addresses #5227, updates to Controller:OutdoorAir #208

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

joseph-robertson
Copy link
Contributor

@joseph-robertson joseph-robertson commented Aug 19, 2024

Pull request overview

Companion PR:

Link to relevant GitHub Issue(s) if appropriate:

Link to the Ubuntu 22.04 .deb installer to use for CI Testing. If not set, it will default to latest official release.
[OpenStudio Installer]: https://openstudio-ci-builds.s3.amazonaws.com/develop/OpenStudio-3.8.0%2Bf63cae5fbc-Ubuntu-22.04-x86_64.deb

This Pull Request is concerning:

  • Case 1 - NewTest: a new test for a new model API class,
  • Case 2 - TestFix: a fix for an existing test. The GitHub issue should be referenced in the PR description
  • Case 3 - NewTestForExisting: a new test for an already-existing model API class
  • Case 4 - Other: Something else, like maintenance of the repo, or just committing test results with a new OpenStudio version.

Depending on your answer, please fill out the required section below, and delete the three others.
Leave the review checklist in place.


Case 3: New test for an already-existing model API class

Test setting the humidistat control zone on ControllerOutdoorAir.

Work Checklist

The following has been checked to ensure compliance with the guidelines:

  • Test has been run backwards:; N/A, this is new in the 3.9.0 release

  • A Matching OSM test has been added with the output of the ruby test for the oldest OpenStudio release where it passes (include OpenStudio Version)

  • Ruby test is stable in the last OpenStudio version: when run multiple times on the same machine, it produces the same total site kBTU.

    • I ensured that I assign systems/loads/etc in a repeatable manner (eg: if I assign stuff to thermalZones, I do model.getThermalZones.sort_by{|z| z.name.to_s}.each do ... so I am sure I put the same ZoneHVAC systems to the same zones regardless of their order)
    • I tested stability using process_results.py (see python process_results.py --help for usage).
      Please paste the text output or heatmap png generated after running the following commands:
      # Clean up all custom-tagged OSWs
      python process_results.py test-stability clean
      # Run your test 5 times in a row. Replace `testname_rb` (eg `airterminal_fourpipebeam_rb`)
      python process_results.py test-stability run -n testname_rb
      # Check that they all passed
      python process_results.py test-status --tagged
      # Check site kBTU differences
      python process_results.py heatmap --tagged
      
  • Object has been added to autosize_hvac.rb to ensure the autosizedXXX values methods do work


Review Checklist

  • Code style (indentation, variable names, strip trailing spaces)
  • Functional code review (it has to work!)
  • Matching OSM test has been added or # TODO added to model_tests.rb
  • Appropriate out.osw have been committed
  • Test is stable
  • Object is tested in autosize_hvac as appropriate
  • The appropriate labels have been added to this PR:
    • One of: NewTest, TestFix, NewTestForExisting, Other
    • If NewTest: add PendingOSM or AddedOSM

@joseph-robertson joseph-robertson added the NewTest PR type: a new test for a new model API class label Aug 19, 2024
@joseph-robertson joseph-robertson self-assigned this Aug 19, 2024
github-rubocop-actions[bot] and others added 2 commits August 19, 2024 17:43
@joseph-robertson joseph-robertson added the PendingOSM A matching OSM test has yet to be added with the next official OpenStudio Release label Oct 10, 2024
@joseph-robertson joseph-robertson marked this pull request as ready for review October 10, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NewTest PR type: a new test for a new model API class PendingOSM A matching OSM test has yet to be added with the next official OpenStudio Release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant