NREL/OpenStudio#1697

Pull request overview

• Companion PR: #1697 - Re-wrap Thermochromic window model properly to handle extensible fields and translation to/from EnergyPlus OpenStudio#5426
• Fix Re-wrap Thermochromic window model properly OpenStudio#1697

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-5426/OpenStudio-3.10.0-rc1%2B1191f7e597-Ubuntu-22.04-x86_64.deb

This Pull Request is concerning:

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

Technically it's not a new class, but the former was very broken and useless, so treating as a new one

Case 1: New test for a new model API class

This pull request is in relation with the Pull Request:

• #1697 - Re-wrap Thermochromic window model properly to handle extensible fields and translation to/from EnergyPlus OpenStudio#5426

It will specifically test for the following classes:

• ThermochromicGlazing

Additionally, it will explicitly test for StandardGlazing and MaterialPropertyGlazingSpectralData which were NOT tested for before

Work Checklist

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

• Tests pass either:

  • with official OpenStudio release (include version):

    • A matching OSM test has been added from the successful run of the Ruby one with the official OpenStudio release
    • The label AddedOSM has been added to this PR
    • All new out.osw have been committed

  • with current develop (incude SHA):

    • The label PendingOSM has been added to this PR
    • A matching OSM test has not yet been added because the official release is pending, but model_tests.rb has a TODO.

    • OpenStudio-resources/model_tests.rb

      Lines 1960 to 1963 in 1e9706c

      	# TODO: To be added in the next official release after: 3.10.0
      	# def test_thermochromic_windows_osm
      	# result = sim_test('thermochromic_windows.osm')
      	# end

    • No out.osw have been committed as they need to be run with an official OpenStudio version

• Ruby test is stable: when run multiple times on the same machine, it produces the same total site kBTU.
  Please paste the heatmap png generated after running the following commands:

  • 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).

• Object has been added to autosize_hvac.rb to ensure the autosizedXXX values methods do work: N/A

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