Skip to content

Conversation

@jmarrec
Copy link
Contributor

@jmarrec jmarrec commented Mar 12, 2025

Pull request overview

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]: http://openstudio-ci-builds.s3-website-us-west-2.amazonaws.com/PR-5365/OpenStudio-3.10.0-alpha%2B51228c2c9b-Ubuntu-22.04-x86_64.deb

This Pull Request is concerning:

  • Case 1 - NewTest: a new test for a new model API class,

Case 1: New test for a new model API class

This pull request is in relation with the Pull Request NREL/OpenStudio#3031, and will specifically test for the following class: OutputControlResilienceSummaries

Work Checklist

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

$ rg Resilience -A1testruns/output_objects.py/run/in.idf 
1217:OutputControl:ResilienceSummaries,
1218-  Extended;                               !- Heat Index Algorithm
--
1239:  ThermalResilienceSummary;               !- Report Name 5
1240-
  • 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

@jmarrec jmarrec added NewTest PR type: a new test for a new model API class AddedOSM A matching OSM test has been added with an official OpenStudio release labels Mar 12, 2025
@jmarrec jmarrec self-assigned this Mar 12, 2025
Comment on lines +91 to +98
###############################################################################
# OUTPUTCONTROL:RESILIENCESUMMARIES #
###############################################################################
if openstudio.VersionString(openstudio.openStudioVersion()) > openstudio.VersionString("3.9.0"):
output_table.addSummaryReport("ThermalResilienceSummary")
output_rs = model.getOutputControlResilienceSummaries()
output_rs.setHeatIndexAlgorithm("Extended") # Default is 'Simplified'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

python version.

Comment on lines +101 to +109
###############################################################################
# OUTPUTCONTROL:RESILIENCESUMMARIES #
###############################################################################
if Gem::Version.new(OpenStudio.openStudioVersion) > Gem::Version.new('3.9.0')
output_table.addSummaryReport('ThermalResilienceSummary')
output_rs = model.getOutputControlResilienceSummaries
output_rs.setHeatIndexAlgorithm('Extended') # Default is 'Simplified'
end

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ruby one.

@jmarrec jmarrec force-pushed the 5355-OutputControlResilienceSummaries branch from a1c2f7c to 8c1445c Compare March 12, 2025 12:04
###############################################################################
# OUTPUTCONTROL:RESILIENCESUMMARIES #
###############################################################################
if openstudio.VersionString(openstudio.openStudioVersion()) > openstudio.VersionString("3.9.0"):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is added to an existing test, so we need the version comparison?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes. I don't have to have 3 new tests just for this dumb object, so added to an existing one.

if openstudio.VersionString(openstudio.openStudioVersion()) > openstudio.VersionString("3.9.0"):
output_table.addSummaryReport("ThermalResilienceSummary")
output_rs = model.getOutputControlResilienceSummaries()
output_rs.setHeatIndexAlgorithm("Extended") # Default is 'Simplified'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does "Simplified" give something "new" in the summary report, or is that just the option to maintain the old behavior?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simplified gives the same as not having the object at all in your IDF. (= old)

@jmarrec jmarrec merged commit 9a190a9 into develop Mar 13, 2025
1 of 3 checks passed
@jmarrec jmarrec deleted the 5355-OutputControlResilienceSummaries branch March 13, 2025 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AddedOSM A matching OSM test has been added with an official OpenStudio release NewTest PR type: a new test for a new model API class

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants