ResStock-HPXML

[joseph-robertson]

Pull Request Description

Subtree to: NREL/OpenStudio-HPXML#372.

Closes #774.

Checklist

Not all may apply:

• Unit tests have been added or updated
• All rake tasks have been run, and pass
• Documentation has been modified appropriately
• Any new options are added to project_testing
• project_testing runs without any failures
• No unexpected regression test changes
• All tests are passing (green) on circleci
• The changelog has been updated appropriately
• This branch is up-to-date with master

For more information on how to perform these checklist items, see the documentation's Advanced Tutorial.

[codecov-io]

Codecov Report

Merging #443 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #443   +/-   ##
=======================================
  Coverage   19.51%   19.51%           
=======================================
  Files          32       32           
  Lines       21327    21327           
=======================================
  Hits         4162     4162           
  Misses      17165    17165           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 42d2385...42d2385. Read the comment docs.

[codecov-commenter]

Codecov Report

Merging #443 into master will decrease coverage by 73.57%.
The diff coverage is 47.45%.

@@             Coverage Diff             @@
##           master     #443       +/-   ##
===========================================
- Coverage   93.44%   19.86%   -73.58%     
===========================================
  Files         168       33      -135     
  Lines       49518    20941    -28577     
===========================================
- Hits        46271     4160    -42111     
- Misses       3247    16781    +13534     

Impacted Files	Coverage Δ
...es/hpxml-measures/BuildResidentialHPXML/measure.rb	71.45% <ø> (ø)
...sures/BuildResidentialHPXML/resources/constants.rb	48.38% <ø> (ø)
...asures/BuildResidentialHPXML/resources/geometry.rb	2.10% <ø> (ø)
...asures/BuildResidentialHPXML/resources/location.rb	25.00% <ø> (ø)
...sures/BuildResidentialHPXML/resources/schedules.rb	17.89% <ø> (ø)
resources/buildstock.rb	66.94% <45.61%> (+0.28%)	⬆️
project_testing/tests/test.rb	80.00% <100.00%> (ø)
resources/meta_measure.rb	34.81% <0.00%> (-34.82%)	⬇️
resources/run_sampling.rb	86.18% <0.00%> (-0.56%)	⬇️
...sources/measures/ResidentialHVACFurnace/measure.rb
... and 178 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a880aa...3f10132. Read the comment docs.

[nmerket]

I'm working on getting this to run in buildstockbatch. A few notes:

First, I'm running into an issue with weather files. The weather files directory is mounted into the simulation container as read only because usually many containers are using that directory at the same time and I don't want them trying to write there and cause conflicts. It looks like the BuildResidentialHPXML measure creates a -cache.csv file for the weather file it is using from the epw and tries to write it back to the directory. I'm not familiar with why we do this, but ideas for fixes include:

• pregenerating all the cache files before simulations begin
• including cache files in weather zip

Second, can we do away with the data_point_out.zip? We end up putting all them in a tarball later thereby double archiving them. As mentioned in NREL/buildstockbatch#182, that causes a problem to get at the data inside the zip files that are inside the tar.gz files.

[shorowit]

Regarding the cache.csv files, this is used to avoid parsing the EPW file for (subsequent) simulations that reference the same EPW. So it's sole purpose is to reduce runtimes. My recollection is that it was around half a second per simulation, but it's been a while since we've checked.

I don't think it's worth "including cache files in weather zip", since that will be additional burden for an analyst to figure out how to do it for AMY/custom weather files.

In addition to "pregenerating all the cache files before simulations begin", a couple other ideas come to mind:

• Update BuildResidentialHPXML to check if it can write to a dir and, if not, fallback to a temp directory. (Would that work here?)
• Update BuildResidentialHPXML to check if it can write to a dir and, if not, do not create the cache file. (In other words, ResStock would not get the reduced runtimes.)

[shorowit]

Regarding the data_point.zip, I assume you're talking about the one that is automatically generated by the OpenStudio-workflow gem (and not specific to ResStock-HPXML)?

If so, I believe there's only one way that it can be suppressed, which is by using the "fast" run option in the OSW (example). However, this option will suppress a number of things (like prevent the OSM file from being written), so that might not be of interest for ResStock?

[codecov-io]

Codecov Report

❗ No coverage uploaded for pull request base (develop@cb9373c). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head f1a459f differs from pull request most recent head afa690a. Consider uploading reports for the commit afa690a to get more accurate results

@@            Coverage Diff             @@
##             develop     #443   +/-   ##
==========================================
  Coverage           ?   65.04%           
==========================================
  Files              ?        7           
  Lines              ?     1107           
  Branches           ?        0           
==========================================
  Hits               ?      720           
  Misses             ?      387           
  Partials           ?        0           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cb9373c...afa690a. Read the comment docs.

[joseph-robertson]

Are these leftover changes from merging develop in?

[aspeake]

Are these leftover changes from merging develop in?

@joseph-robertson which commit are you referring to? Some of these changes are, namely the updates to integrity_checks.rb to work with changes to methods in buildstock.rb on develop. The tsv changes are updates after the sampling probability bug fix in resstock-estimation.

[aspeake]

👍👍

[afontani]

Awesome work @joseph-robertson, @aspeake, @shorowit!!!