urbanopt-cli 0.8.3 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (649) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +5 -6
  3. data/CHANGELOG.md +14 -0
  4. data/CMakeLists.txt +7 -7
  5. data/Gemfile +3 -1
  6. data/README.md +9 -0
  7. data/example_files/Gemfile +23 -16
  8. data/example_files/Gemfile.lock +177 -0
  9. data/example_files/base_workflow_res.osw +57 -14
  10. data/example_files/class_project_coincident.json +1322 -0
  11. data/example_files/class_project_diverse.json +1322 -0
  12. data/example_files/disco/config.json +42 -0
  13. data/example_files/disco/cost_database.xlsx +0 -0
  14. data/example_files/disco/technical_catalog.json +12126 -0
  15. data/example_files/mappers/Baseline.rb +10 -7
  16. data/example_files/mappers/ChilledWaterStorage.rb +98 -0
  17. data/example_files/mappers/ClassProject.rb +110 -0
  18. data/example_files/mappers/CreateBar.rb +1 -0
  19. data/example_files/mappers/HighEfficiency.rb +13 -11
  20. data/example_files/mappers/PeakHoursMelsShedding.rb +72 -0
  21. data/example_files/mappers/PeakHoursThermostatAdjust.rb +78 -0
  22. data/example_files/mappers/ThermalStorage.rb +1 -0
  23. data/example_files/mappers/base_workflow.osw +55 -14
  24. data/example_files/mappers/class_project_workflow.osw +328 -0
  25. data/example_files/mappers/createbar_workflow.osw +16 -16
  26. data/example_files/measures/BuildResidentialModel/measure.rb +7 -1
  27. data/example_files/measures/BuildResidentialModel/measure.xml +1313 -706
  28. data/example_files/opendss/electrical_database.json +1446 -1446
  29. data/example_files/python_deps/dependencies.json +5 -0
  30. data/example_files/python_deps/install_python.ps1 +96 -0
  31. data/example_files/python_deps/install_python.sh +120 -0
  32. data/example_files/residential/clothes_dryer.tsv +11 -11
  33. data/example_files/residential/clothes_washer.tsv +3 -3
  34. data/example_files/residential/dishwasher.tsv +3 -3
  35. data/example_files/resources/hpxml-measures/.github/pull_request_template.md +0 -1
  36. data/example_files/resources/hpxml-measures/.github/workflows/config.yml +8 -21
  37. data/example_files/resources/hpxml-measures/.gitignore +2 -0
  38. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/measure.rb +1272 -1094
  39. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/measure.xml +978 -659
  40. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/geometry.rb +52 -74
  41. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/build_residential_hpxml_test.rb +77 -140
  42. data/example_files/resources/hpxml-measures/BuildResidentialScheduleFile/measure.rb +30 -27
  43. data/example_files/resources/hpxml-measures/BuildResidentialScheduleFile/measure.xml +32 -13
  44. data/example_files/resources/hpxml-measures/BuildResidentialScheduleFile/resources/schedules.rb +55 -51
  45. data/example_files/resources/hpxml-measures/BuildResidentialScheduleFile/tests/build_residential_schedule_file_test.rb +89 -16
  46. data/example_files/resources/hpxml-measures/Changelog.md +65 -0
  47. data/example_files/resources/hpxml-measures/Gemfile +2 -4
  48. data/example_files/resources/hpxml-measures/Gemfile.lock +2 -13
  49. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/measure.rb +276 -300
  50. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml +221 -215
  51. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/airflow.rb +215 -170
  52. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/battery.rb +108 -16
  53. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/constants.rb +24 -44
  54. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/constructions.rb +564 -197
  55. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/data/cambium/README.md +8 -8
  56. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/energyplus.rb +1 -0
  57. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/geometry.rb +7 -55
  58. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hotwater_appliances.rb +24 -19
  59. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml.rb +541 -211
  60. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_defaults.rb +300 -172
  61. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd +0 -2
  62. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_schema/HPXMLBaseElements.xsd +230 -141
  63. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_schema/HPXMLDataTypes.xsd +145 -137
  64. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml +191 -97
  65. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_schematron/iso-schematron.xsd +391 -0
  66. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hvac.rb +194 -198
  67. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hvac_sizing.rb +140 -145
  68. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/lighting.rb +11 -11
  69. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/location.rb +33 -1
  70. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/materials.rb +4 -4
  71. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/meta_measure.rb +17 -9
  72. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/misc_loads.rb +14 -12
  73. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/output.rb +39 -17
  74. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/psychrometrics.rb +1 -1
  75. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/schedule_files/battery.csv +8761 -0
  76. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/schedules.rb +114 -57
  77. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/simcontrols.rb +1 -0
  78. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/utility_bills.rb +148 -0
  79. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/version.rb +2 -2
  80. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/waterheater.rb +85 -127
  81. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/weather.rb +26 -32
  82. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/xmlhelper.rb +2 -14
  83. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/xmlvalidator.rb +67 -0
  84. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_airflow.rb +117 -56
  85. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_battery.rb +141 -14
  86. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_defaults.rb +453 -344
  87. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_enclosure.rb +124 -20
  88. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_generator.rb +1 -1
  89. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hotwater_appliance.rb +28 -32
  90. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hvac.rb +172 -79
  91. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hvac_sizing.rb +54 -8
  92. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_lighting.rb +3 -3
  93. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_location.rb +4 -4
  94. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_miscloads.rb +7 -7
  95. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_pv.rb +1 -1
  96. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_schedules.rb +6 -9
  97. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_simcontrols.rb +8 -8
  98. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_validation.rb +213 -95
  99. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_water_heater.rb +1 -10
  100. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_weather.rb +76 -0
  101. data/example_files/resources/hpxml-measures/README.md +2 -3
  102. data/example_files/resources/hpxml-measures/ReportSimulationOutput/measure.rb +585 -287
  103. data/example_files/resources/hpxml-measures/ReportSimulationOutput/measure.xml +304 -352
  104. data/example_files/resources/hpxml-measures/ReportSimulationOutput/tests/output_report_test.rb +404 -279
  105. data/example_files/resources/hpxml-measures/ReportUtilityBills/measure.rb +222 -501
  106. data/example_files/resources/hpxml-measures/ReportUtilityBills/measure.xml +137 -200
  107. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Flat Rate Min Annual Charge.json +649 -0
  108. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Flat Rate Min Monthly Charge.json +649 -0
  109. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Flat Rate.json +647 -0
  110. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Real-Time Pricing Rate Min Annual Charge.json +8776 -0
  111. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Real-Time Pricing Rate Min Monthly Charge.json +8776 -0
  112. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Real-Time Pricing Rate.json +8774 -0
  113. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Tiered Rate Min Annual Charge.json +659 -0
  114. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Tiered Rate Min Monthly Charge.json +659 -0
  115. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Tiered Rate.json +657 -0
  116. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Tiered Time-of-Use Rate Min Annual Charge.json +670 -0
  117. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Tiered Time-of-Use Rate Min Monthly Charge.json +670 -0
  118. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Tiered Time-of-Use Rate.json +668 -0
  119. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Time-of-Use Rate Min Annual Charge.json +655 -0
  120. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Time-of-Use Rate Min Monthly Charge.json +655 -0
  121. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/Sample Time-of-Use Rate.json +653 -0
  122. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/detailed_rates/openei_rates.zip +0 -0
  123. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/{Data/UtilityRates → simple_rates}/Average_retail_price_of_electricity.csv +0 -0
  124. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/{Data/UtilityRates → simple_rates}/HouseholdConsumption.csv +0 -0
  125. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/{Data/UtilityRates → simple_rates}/NG_PRI_SUM_A_EPG0_PRS_DMCF_A.csv +0 -0
  126. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/{Data/UtilityRates → simple_rates}/PET_PRI_WFR_A_EPD2F_PRS_DPGAL_W.csv +0 -0
  127. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/{Data/UtilityRates → simple_rates}/PET_PRI_WFR_A_EPLLPA_PRS_DPGAL_W.csv +0 -0
  128. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/{Data/UtilityRates → simple_rates}/README.md +0 -0
  129. data/example_files/resources/hpxml-measures/ReportUtilityBills/resources/util.rb +506 -25
  130. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/Contains Demand Charges.json +1312 -0
  131. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/Invalid Fixed Charge Units.json +657 -0
  132. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/Invalid Min Charge Units.json +659 -0
  133. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/JacksonElectricMemberCorp-ResidentialSeniorCitizenLowIncomeAssistance.json +681 -0
  134. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/Missing Required Fields.json +54 -0
  135. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/data.csv +8761 -0
  136. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/utility_bills_test.rb +1006 -235
  137. data/example_files/resources/hpxml-measures/docs/source/conf.py +1 -1
  138. data/example_files/resources/hpxml-measures/docs/source/intro.rst +0 -1
  139. data/example_files/resources/hpxml-measures/docs/source/usage_instructions.rst +2 -2
  140. data/example_files/resources/hpxml-measures/docs/source/workflow_inputs.rst +461 -261
  141. data/example_files/resources/hpxml-measures/docs/source/workflow_outputs.rst +146 -152
  142. data/example_files/resources/hpxml-measures/tasks.rb +616 -802
  143. data/example_files/resources/hpxml-measures/workflow/real_homes/house001.xml +19 -11
  144. data/example_files/resources/hpxml-measures/workflow/real_homes/house002.xml +20 -12
  145. data/example_files/resources/hpxml-measures/workflow/real_homes/house003.xml +12 -7
  146. data/example_files/resources/hpxml-measures/workflow/real_homes/house004.xml +12 -7
  147. data/example_files/resources/hpxml-measures/workflow/real_homes/house005.xml +19 -11
  148. data/example_files/resources/hpxml-measures/workflow/real_homes/house006.xml +12 -7
  149. data/example_files/resources/hpxml-measures/workflow/real_homes/house007.xml +20 -12
  150. data/example_files/resources/hpxml-measures/workflow/real_homes/house008.xml +28 -16
  151. data/example_files/resources/hpxml-measures/workflow/real_homes/house009.xml +28 -17
  152. data/example_files/resources/hpxml-measures/workflow/real_homes/house010.xml +28 -16
  153. data/example_files/resources/hpxml-measures/workflow/real_homes/house011.xml +20 -12
  154. data/example_files/resources/hpxml-measures/workflow/real_homes/house012.xml +20 -12
  155. data/example_files/resources/hpxml-measures/workflow/real_homes/house013.xml +20 -12
  156. data/example_files/resources/hpxml-measures/workflow/real_homes/house014.xml +20 -12
  157. data/example_files/resources/hpxml-measures/workflow/real_homes/house015.xml +20 -12
  158. data/example_files/resources/hpxml-measures/workflow/real_homes/house016.xml +22 -12
  159. data/example_files/resources/hpxml-measures/workflow/real_homes/house017.xml +19 -11
  160. data/example_files/resources/hpxml-measures/workflow/real_homes/house018.xml +20 -12
  161. data/example_files/resources/hpxml-measures/workflow/real_homes/house019.xml +13 -7
  162. data/example_files/resources/hpxml-measures/workflow/real_homes/house020.xml +12 -7
  163. data/example_files/resources/hpxml-measures/workflow/real_homes/house021.xml +31 -16
  164. data/example_files/resources/hpxml-measures/workflow/real_homes/house022.xml +22 -12
  165. data/example_files/resources/hpxml-measures/workflow/real_homes/house023.xml +21 -12
  166. data/example_files/resources/hpxml-measures/workflow/real_homes/house024.xml +37 -22
  167. data/example_files/resources/hpxml-measures/workflow/real_homes/house025.xml +24 -12
  168. data/example_files/resources/hpxml-measures/workflow/real_homes/house026.xml +33 -21
  169. data/example_files/resources/hpxml-measures/workflow/real_homes/house027.xml +28 -16
  170. data/example_files/resources/hpxml-measures/workflow/real_homes/house028.xml +28 -16
  171. data/example_files/resources/hpxml-measures/workflow/real_homes/house029.xml +30 -17
  172. data/example_files/resources/hpxml-measures/workflow/real_homes/house030.xml +10 -7
  173. data/example_files/resources/hpxml-measures/workflow/real_homes/house031.xml +22 -11
  174. data/example_files/resources/hpxml-measures/workflow/real_homes/house032.xml +12 -7
  175. data/example_files/resources/hpxml-measures/workflow/real_homes/house033.xml +18 -12
  176. data/example_files/resources/hpxml-measures/workflow/real_homes/house034.xml +25 -16
  177. data/example_files/resources/hpxml-measures/workflow/real_homes/house035.xml +22 -12
  178. data/example_files/resources/hpxml-measures/workflow/real_homes/house036.xml +20 -12
  179. data/example_files/resources/hpxml-measures/workflow/real_homes/house037.xml +26 -17
  180. data/example_files/resources/hpxml-measures/workflow/real_homes/house038.xml +19 -11
  181. data/example_files/resources/hpxml-measures/workflow/real_homes/house039.xml +25 -16
  182. data/example_files/resources/hpxml-measures/workflow/real_homes/house040.xml +20 -12
  183. data/example_files/resources/hpxml-measures/workflow/real_homes/house041.xml +35 -21
  184. data/example_files/resources/hpxml-measures/workflow/real_homes/house042.xml +28 -17
  185. data/example_files/resources/hpxml-measures/workflow/real_homes/house043.xml +20 -12
  186. data/example_files/resources/hpxml-measures/workflow/real_homes/house044.xml +35 -21
  187. data/example_files/resources/hpxml-measures/workflow/real_homes/house045.xml +20 -12
  188. data/example_files/resources/hpxml-measures/workflow/real_homes/house046.xml +20 -13
  189. data/example_files/resources/hpxml-measures/workflow/real_homes/house047.xml +12 -9
  190. data/example_files/resources/hpxml-measures/workflow/real_homes/house048.xml +25 -14
  191. data/example_files/resources/hpxml-measures/workflow/real_homes/house049.xml +10 -7
  192. data/example_files/resources/hpxml-measures/workflow/real_homes/house050.xml +20 -11
  193. data/example_files/resources/hpxml-measures/workflow/run_simulation.rb +91 -88
  194. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-coal.xml +18 -7
  195. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier-ief-portable.xml +546 -535
  196. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier-ief-whole-home.xml +546 -535
  197. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier-multiple.xml +555 -544
  198. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier.xml +18 -7
  199. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-gas.xml +18 -7
  200. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-modified.xml +18 -7
  201. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-none.xml +18 -7
  202. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-oil-location-miami-fl.xml +580 -569
  203. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-oil.xml +18 -7
  204. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-propane-location-portland-or.xml +580 -569
  205. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-propane.xml +18 -7
  206. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-wood.xml +18 -7
  207. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-cathedral.xml +7 -0
  208. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-conditioned.xml +17 -6
  209. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-flat.xml +7 -0
  210. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-radiant-barrier.xml +18 -7
  211. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-unvented-insulated-roof.xml +18 -7
  212. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-vented.xml +18 -7
  213. data/example_files/resources/hpxml-measures/workflow/sample_files/base-battery-scheduled.xml +600 -0
  214. data/example_files/resources/hpxml-measures/workflow/sample_files/base-battery.xml +598 -587
  215. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-adjacent-to-multifamily-buffer-space.xml +494 -485
  216. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-adjacent-to-multiple.xml +606 -593
  217. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-adjacent-to-non-freezing-space.xml +494 -485
  218. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-adjacent-to-other-heated-space.xml +494 -485
  219. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-adjacent-to-other-housing-unit.xml +494 -485
  220. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-calctype-operational.xml +480 -471
  221. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-baseboard.xml +464 -457
  222. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-fan-coil-ducted.xml +496 -487
  223. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-fan-coil.xml +466 -459
  224. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-water-loop-heat-pump.xml +518 -509
  225. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-cooling-tower-water-loop-heat-pump.xml +513 -504
  226. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-baseboard.xml +445 -438
  227. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil-ducted.xml +476 -467
  228. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil-eae.xml +443 -436
  229. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil.xml +446 -439
  230. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-water-loop-heat-pump.xml +494 -485
  231. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-baseboard.xml +445 -438
  232. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-fan-coil-ducted.xml +476 -467
  233. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-fan-coil.xml +446 -439
  234. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-water-loop-heat-pump.xml +494 -485
  235. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-cooling-tower-only-water-loop-heat-pump.xml +489 -480
  236. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-generator.xml +499 -490
  237. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-ground-loop-ground-to-air-heat-pump.xml +491 -482
  238. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-laundry-room-multiple-water-heaters.xml +510 -0
  239. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-laundry-room.xml +495 -486
  240. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-mechvent-multiple.xml +709 -695
  241. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-mechvent-preconditioning.xml +528 -519
  242. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-mechvent.xml +512 -503
  243. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-pv.xml +504 -495
  244. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-water-heater-recirc.xml +497 -488
  245. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-water-heater.xml +490 -481
  246. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily.xml +487 -478
  247. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-single-family-attached-2stories.xml +639 -628
  248. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-single-family-attached-atticroof-cathedral.xml +587 -580
  249. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-single-family-attached.xml +639 -628
  250. data/example_files/resources/hpxml-measures/workflow/sample_files/base-calctype-operational-misc-defaults.xml +539 -528
  251. data/example_files/resources/hpxml-measures/workflow/sample_files/base-calctype-operational-misc-loads-large-uncommon.xml +644 -633
  252. data/example_files/resources/hpxml-measures/workflow/sample_files/base-calctype-operational-misc-loads-large-uncommon2.xml +644 -633
  253. data/example_files/resources/hpxml-measures/workflow/sample_files/base-calctype-operational.xml +575 -564
  254. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-combi-tankless-outside.xml +16 -7
  255. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-combi-tankless.xml +16 -7
  256. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-2-speed.xml +18 -7
  257. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-gshp.xml +585 -574
  258. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-hpwh.xml +18 -7
  259. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-tankless.xml +18 -7
  260. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-var-speed.xml +18 -7
  261. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater.xml +18 -7
  262. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-dwhr.xml +18 -7
  263. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-detailed-setpoints.xml +536 -0
  264. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-dse.xml +16 -7
  265. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-outside.xml +16 -7
  266. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-standbyloss.xml +20 -8
  267. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-with-solar-fraction.xml +16 -7
  268. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect.xml +16 -7
  269. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-electric.xml +18 -7
  270. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-gas.xml +18 -7
  271. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-hpwh.xml +18 -7
  272. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-indirect.xml +16 -7
  273. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-low-flow-fixtures.xml +18 -7
  274. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-multiple.xml +16 -7
  275. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-none.xml +18 -7
  276. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-demand.xml +19 -8
  277. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-manual.xml +19 -8
  278. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-nocontrol.xml +19 -8
  279. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-temperature.xml +19 -8
  280. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-timer.xml +19 -8
  281. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-evacuated-tube.xml +18 -7
  282. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-flat-plate.xml +18 -7
  283. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-ics.xml +18 -7
  284. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-fraction.xml +18 -7
  285. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-indirect-flat-plate.xml +18 -7
  286. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-thermosyphon-flat-plate.xml +18 -7
  287. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-coal.xml +18 -7
  288. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-detailed-setpoints.xml +582 -571
  289. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-elec-uef.xml +583 -572
  290. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas-outside.xml +18 -7
  291. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas-uef-fhr.xml +584 -573
  292. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas-uef.xml +584 -573
  293. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas.xml +18 -7
  294. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-detailed-schedules.xml +583 -572
  295. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-operating-mode-heat-pump-only.xml +585 -574
  296. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-outside.xml +18 -7
  297. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-uef.xml +582 -571
  298. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-with-solar-fraction.xml +18 -7
  299. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-with-solar.xml +18 -7
  300. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump.xml +18 -7
  301. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-model-type-stratified-detailed-occupancy-stochastic.xml +586 -575
  302. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-model-type-stratified.xml +585 -574
  303. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-oil.xml +18 -7
  304. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-wood.xml +18 -7
  305. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-detailed-setpoints.xml +580 -569
  306. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric-outside.xml +18 -7
  307. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric-uef.xml +580 -569
  308. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric.xml +18 -7
  309. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-uef.xml +580 -569
  310. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-with-solar-fraction.xml +18 -7
  311. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-with-solar.xml +18 -7
  312. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas.xml +18 -7
  313. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-propane.xml +18 -7
  314. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-2stories-garage.xml +28 -11
  315. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-2stories.xml +20 -7
  316. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-1.xml +18 -7
  317. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-2.xml +18 -7
  318. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-4.xml +18 -7
  319. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-5.xml +18 -7
  320. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-ceilingtypes.xml +607 -0
  321. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-floortypes.xml +550 -0
  322. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-garage.xml +27 -12
  323. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-ach-house-pressure.xml +18 -7
  324. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-cfm-house-pressure.xml +18 -7
  325. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-cfm50.xml +18 -7
  326. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-flue.xml +18 -7
  327. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-natural-ach.xml +18 -7
  328. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-orientations.xml +589 -578
  329. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-overhangs.xml +18 -7
  330. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-rooftypes.xml +18 -7
  331. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-skylights-physical-properties.xml +619 -608
  332. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-skylights-shading.xml +620 -609
  333. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-skylights-storms.xml +618 -607
  334. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-skylights.xml +18 -7
  335. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-level.xml +537 -526
  336. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-surfaces.xml +90 -43
  337. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-surfaces2.xml +2507 -2460
  338. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-thermal-mass.xml +595 -584
  339. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-walltypes.xml +19 -8
  340. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-natural-ventilation-availability.xml +584 -0
  341. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-none.xml +18 -7
  342. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-physical-properties.xml +594 -583
  343. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-shading.xml +597 -586
  344. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-storms.xml +598 -587
  345. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-ambient.xml +27 -12
  346. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-basement-garage.xml +671 -656
  347. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-complex.xml +18 -7
  348. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-conditioned-basement-slab-insulation.xml +18 -7
  349. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-foundation-conditioned-basement-wall-interior-insulation.xml → base-foundation-conditioned-basement-wall-insulation.xml} +585 -574
  350. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-conditioned-crawlspace.xml +582 -571
  351. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-multiple.xml +35 -16
  352. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-slab.xml +18 -7
  353. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-above-grade.xml +27 -12
  354. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-assembly-r.xml +27 -12
  355. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-wall-insulation.xml +27 -12
  356. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement.xml +27 -12
  357. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unvented-crawlspace.xml +27 -12
  358. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-vented-crawlspace.xml +27 -12
  359. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-walkout-basement.xml +18 -7
  360. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-1-speed-backup-lockout-temperature.xml +586 -575
  361. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-1-speed-cooling-only.xml +573 -562
  362. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-1-speed-heating-only.xml +580 -569
  363. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-1-speed-seer2-hspf2.xml +583 -0
  364. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-1-speed.xml +18 -7
  365. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-2-speed.xml +18 -7
  366. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-var-speed-backup-boiler-switchover-temperature.xml +600 -589
  367. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-var-speed-backup-boiler.xml +599 -588
  368. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-var-speed-backup-furnace.xml +629 -616
  369. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-var-speed.xml +18 -7
  370. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-cooling-only.xml +573 -562
  371. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-heating-only.xml +579 -568
  372. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-sizing-methodology-acca.xml +581 -570
  373. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-sizing-methodology-hers.xml +581 -570
  374. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-sizing-methodology-maxload-miami-fl.xml +582 -0
  375. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-sizing-methodology-maxload.xml +581 -570
  376. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-2-speed-sizing-methodology-acca.xml +581 -570
  377. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-2-speed-sizing-methodology-hers.xml +581 -570
  378. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-2-speed-sizing-methodology-maxload.xml +581 -570
  379. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-var-speed-backup-boiler.xml +598 -587
  380. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-var-speed-backup-furnace.xml +628 -615
  381. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-var-speed-sizing-methodology-acca.xml +581 -570
  382. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-var-speed-sizing-methodology-hers.xml +581 -570
  383. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-var-speed-sizing-methodology-maxload.xml +581 -570
  384. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-boiler-elec-only.xml +535 -526
  385. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-boiler-gas-central-ac-1-speed.xml +589 -578
  386. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-boiler-gas-only.xml +536 -527
  387. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-central-ac-only-1-speed.xml +18 -7
  388. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-central-ac-only-2-speed.xml +565 -554
  389. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-central-ac-only-var-speed.xml +565 -554
  390. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-central-ac-plus-air-to-air-heat-pump-heating.xml +18 -7
  391. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-dual-fuel-air-to-air-heat-pump-1-speed-sizing-methodology-acca.xml +582 -571
  392. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-dual-fuel-air-to-air-heat-pump-1-speed-sizing-methodology-hers.xml +582 -571
  393. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-dual-fuel-air-to-air-heat-pump-1-speed-sizing-methodology-maxload.xml +582 -571
  394. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-dual-fuel-mini-split-heat-pump-ducted.xml +18 -7
  395. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-elec-resistance-only.xml +526 -517
  396. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-evap-cooler-furnace-gas.xml +573 -562
  397. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-floor-furnace-propane-only.xml +529 -520
  398. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-furnace-elec-only.xml +565 -554
  399. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-furnace-gas-central-ac-2-speed.xml +580 -569
  400. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-furnace-gas-central-ac-var-speed.xml +580 -569
  401. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-furnace-gas-only.xml +565 -554
  402. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-furnace-gas-room-ac.xml +578 -567
  403. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ground-to-air-heat-pump-cooling-only.xml +575 -564
  404. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ground-to-air-heat-pump-heating-only.xml +581 -570
  405. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ground-to-air-heat-pump-sizing-methodology-acca.xml +583 -572
  406. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ground-to-air-heat-pump-sizing-methodology-hers.xml +583 -572
  407. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ground-to-air-heat-pump-sizing-methodology-maxload.xml +583 -572
  408. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-air-conditioner-only-ducted.xml +18 -7
  409. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-heat-pump-ducted-cooling-only.xml +18 -7
  410. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-heat-pump-ducted-heating-only.xml +18 -7
  411. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-heat-pump-ducted-sizing-methodology-acca.xml +580 -569
  412. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-heat-pump-ducted-sizing-methodology-hers.xml +580 -569
  413. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-heat-pump-ducted-sizing-methodology-maxload.xml +580 -569
  414. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-heat-pump-ductless-backup-stove.xml +551 -542
  415. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ptac-with-heating.xml +532 -530
  416. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ptac.xml +525 -516
  417. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-pthp-sizing-methodology-acca.xml +541 -532
  418. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-pthp-sizing-methodology-hers.xml +541 -532
  419. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-pthp-sizing-methodology-maxload.xml +541 -532
  420. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-room-ac-only.xml +525 -516
  421. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-room-ac-with-heating.xml +533 -0
  422. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-room-ac-with-reverse-cycle-sizing-methodology-acca.xml +542 -0
  423. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-room-ac-with-reverse-cycle-sizing-methodology-hers.xml +542 -0
  424. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-room-ac-with-reverse-cycle-sizing-methodology-maxload.xml +542 -0
  425. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-stove-oil-only.xml +529 -520
  426. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-wall-furnace-elec-only.xml +529 -520
  427. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize.xml +580 -569
  428. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-coal-only.xml +16 -7
  429. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-elec-only.xml +16 -7
  430. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-gas-central-ac-1-speed.xml +18 -7
  431. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-gas-only.xml +16 -7
  432. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-oil-only.xml +16 -7
  433. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-propane-only.xml +16 -7
  434. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-wood-only.xml +16 -7
  435. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-1-speed-seer2.xml +567 -0
  436. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-1-speed.xml +18 -7
  437. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-2-speed.xml +18 -7
  438. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-var-speed.xml +18 -7
  439. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-plus-air-to-air-heat-pump-heating.xml +18 -7
  440. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dse.xml +16 -7
  441. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed-electric.xml +18 -7
  442. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed.xml +18 -7
  443. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-2-speed.xml +18 -7
  444. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-var-speed.xml +18 -7
  445. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-mini-split-heat-pump-ducted.xml +18 -7
  446. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ducts-area-fractions.xml +611 -598
  447. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ducts-area-multipliers.xml +589 -0
  448. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ducts-leakage-cfm50.xml +582 -571
  449. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ducts-leakage-percent.xml +18 -7
  450. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-elec-resistance-only.xml +16 -7
  451. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-furnace-gas.xml +18 -7
  452. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-only-ducted.xml +17 -7
  453. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-only.xml +16 -7
  454. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-fireplace-wood-only.xml +530 -521
  455. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-fixed-heater-gas-only.xml +530 -521
  456. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-floor-furnace-propane-only.xml +530 -521
  457. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-coal-only.xml +566 -555
  458. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-elec-central-ac-1-speed.xml +18 -7
  459. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-elec-only.xml +18 -7
  460. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-central-ac-2-speed.xml +18 -7
  461. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-central-ac-var-speed.xml +18 -7
  462. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-only-detailed-setpoints.xml +566 -555
  463. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-only.xml +566 -555
  464. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-room-ac.xml +18 -7
  465. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-oil-only.xml +18 -7
  466. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-propane-only.xml +18 -7
  467. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-wood-only.xml +18 -7
  468. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-x3-dse.xml +16 -7
  469. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ground-to-air-heat-pump-cooling-only.xml +574 -563
  470. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ground-to-air-heat-pump-heating-only.xml +581 -570
  471. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ground-to-air-heat-pump.xml +583 -572
  472. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-air-to-air-heat-pump-1-speed.xml +587 -576
  473. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-air-to-air-heat-pump-2-speed.xml +587 -576
  474. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-air-to-air-heat-pump-var-speed.xml +587 -576
  475. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-furnace-gas-central-ac-1-speed.xml +591 -580
  476. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-furnace-gas-central-ac-2-speed.xml +591 -580
  477. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-furnace-gas-central-ac-var-speed.xml +591 -580
  478. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-furnace-gas-only.xml +570 -559
  479. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-ground-to-air-heat-pump.xml +586 -575
  480. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-mini-split-air-conditioner-only-ducted.xml +570 -559
  481. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-mini-split-heat-pump-ducted.xml +586 -575
  482. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-air-conditioner-only-ducted.xml +18 -7
  483. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-air-conditioner-only-ductless.xml +16 -7
  484. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted-cooling-only.xml +18 -7
  485. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted-heating-only.xml +18 -7
  486. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted.xml +18 -7
  487. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ductless-backup-stove.xml +552 -543
  488. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ductless.xml +16 -7
  489. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-multiple.xml +963 -938
  490. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-none.xml +33 -69
  491. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-portable-heater-gas-only.xml +530 -521
  492. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ptac-with-heating-electricity.xml +535 -0
  493. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-hvac-ptac-with-heating.xml → base-hvac-ptac-with-heating-natural-gas.xml} +23 -21
  494. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ptac.xml +526 -517
  495. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-pthp.xml +541 -532
  496. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only-33percent.xml +16 -7
  497. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only-ceer.xml +526 -517
  498. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only-detailed-setpoints.xml +526 -517
  499. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only.xml +16 -7
  500. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-with-heating.xml +535 -0
  501. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-with-reverse-cycle.xml +542 -0
  502. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-seasons.xml +594 -583
  503. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-setpoints-daily-schedules.xml +586 -575
  504. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-setpoints-daily-setbacks.xml +18 -7
  505. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-setpoints.xml +18 -7
  506. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-stove-oil-only.xml +530 -521
  507. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-stove-wood-pellets-only.xml +530 -521
  508. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-undersized-allow-increased-fixed-capacities.xml +18 -7
  509. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-undersized.xml +18 -7
  510. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-wall-furnace-elec-only.xml +530 -521
  511. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-ceiling-fans.xml +18 -7
  512. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-holiday.xml +18 -7
  513. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-none.xml +18 -7
  514. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-AMY-2012.xml +18 -7
  515. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-baltimore-md.xml +27 -12
  516. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-capetown-zaf.xml +591 -576
  517. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-dallas-tx.xml +18 -7
  518. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-duluth-mn.xml +27 -12
  519. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-helena-mt.xml +582 -571
  520. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-honolulu-hi.xml +537 -526
  521. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-miami-fl.xml +18 -7
  522. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-phoenix-az.xml +537 -526
  523. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-portland-or.xml +601 -586
  524. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-balanced.xml +18 -7
  525. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-bath-kitchen-fans.xml +18 -7
  526. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-airflow-fraction-zero.xml +601 -587
  527. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-dse.xml +19 -7
  528. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-evap-cooler-only-ducted.xml +20 -7
  529. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-supplemental-fan-exhaust.xml +607 -0
  530. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-supplemental-fan-supply.xml +607 -0
  531. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis.xml +21 -7
  532. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-erv-atre-asre.xml +18 -7
  533. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-erv.xml +18 -7
  534. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-exhaust-rated-flow-rate.xml +18 -7
  535. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-exhaust.xml +18 -7
  536. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-hrv-asre.xml +18 -7
  537. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-hrv.xml +18 -7
  538. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-multiple.xml +37 -19
  539. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-supply.xml +18 -7
  540. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-whole-house-fan.xml +18 -7
  541. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-additional-properties.xml +590 -579
  542. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-bills-none.xml +578 -0
  543. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-bills-pv-detailed-only.xml +632 -0
  544. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-bills-pv-mixed.xml +614 -0
  545. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-bills-pv.xml +677 -0
  546. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-bills.xml +593 -0
  547. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-defaults.xml +27 -9
  548. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-emissions.xml +676 -665
  549. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-generators-battery-scheduled.xml +616 -0
  550. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-generators-battery.xml +615 -0
  551. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-generators.xml +598 -587
  552. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-ground-conductivity.xml +586 -0
  553. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-large-uncommon.xml +18 -7
  554. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-large-uncommon2.xml +18 -7
  555. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-none.xml +18 -7
  556. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-neighbor-shading.xml +18 -7
  557. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-shielding-of-home.xml +583 -572
  558. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-usage-multiplier.xml +18 -7
  559. data/example_files/resources/hpxml-measures/workflow/sample_files/base-multiple-buildings.xml +1700 -1677
  560. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-battery-ah.xml +622 -611
  561. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-battery-garage.xml +697 -682
  562. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-pv-battery-lifetime-model.xml → base-pv-battery-round-trip-efficiency.xml} +20 -11
  563. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-battery-scheduled.xml +624 -0
  564. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-battery.xml +622 -611
  565. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-generators-battery-scheduled.xml +640 -0
  566. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-generators-battery.xml +639 -0
  567. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-generators.xml +623 -0
  568. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv.xml +606 -595
  569. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-all-10-mins.xml +582 -571
  570. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-occupancy-smooth.xml +583 -572
  571. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-occupancy-stochastic-10-mins.xml +584 -0
  572. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-occupancy-stochastic-vacancy.xml +583 -572
  573. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-occupancy-stochastic.xml +583 -572
  574. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-setpoints-daily-schedules.xml +581 -570
  575. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-setpoints-daily-setbacks.xml +581 -570
  576. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-detailed-setpoints.xml +581 -570
  577. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-simple.xml +636 -625
  578. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-calendar-year-custom.xml +18 -7
  579. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-daylight-saving-custom.xml +27 -14
  580. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-daylight-saving-disabled.xml +21 -10
  581. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-runperiod-1-month.xml +21 -10
  582. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-dhw-tank-heat-pump-detailed-operating-modes.xml → base-simcontrol-temperature-capacitance-multiplier.xml} +25 -13
  583. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-timestep-10-mins-occupancy-stochastic-10-mins.xml +584 -0
  584. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-timestep-10-mins-occupancy-stochastic-60-mins.xml +584 -0
  585. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-timestep-10-mins.xml +18 -7
  586. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-dhw-tank-heat-pump-detailed-setpoints.xml → base-simcontrol-timestep-30-mins.xml} +25 -14
  587. data/example_files/resources/hpxml-measures/workflow/sample_files/base.xml +18 -7
  588. data/example_files/resources/hpxml-measures/workflow/template-build-and-run-hpxml-with-stochastic-occupancy.osw +18 -13
  589. data/example_files/resources/hpxml-measures/workflow/template-run-hpxml-with-stochastic-occupancy.osw +12 -7
  590. data/example_files/resources/hpxml-measures/workflow/template-run-hpxml.osw +8 -24
  591. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L100AC.xml +366 -358
  592. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L100AL.xml +369 -361
  593. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L110AC.xml +369 -361
  594. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L110AL.xml +369 -361
  595. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L120AC.xml +369 -361
  596. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L120AL.xml +369 -361
  597. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L130AC.xml +369 -361
  598. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L130AL.xml +369 -361
  599. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L140AC.xml +311 -303
  600. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L140AL.xml +311 -303
  601. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L150AC.xml +327 -319
  602. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L150AL.xml +327 -319
  603. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L155AC.xml +332 -324
  604. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L155AL.xml +332 -324
  605. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L160AC.xml +341 -333
  606. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L160AL.xml +341 -333
  607. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L170AC.xml +369 -361
  608. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L170AL.xml +369 -361
  609. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L200AC.xml +369 -361
  610. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L200AL.xml +369 -361
  611. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L202AC.xml +369 -361
  612. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L202AL.xml +369 -361
  613. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L302XC.xml +383 -379
  614. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L304XC.xml +383 -379
  615. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L322XC.xml +538 -534
  616. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L324XC.xml +550 -546
  617. data/example_files/resources/hpxml-measures/workflow/tests/base_results/results.csv +444 -410
  618. data/example_files/resources/hpxml-measures/workflow/tests/base_results/results_ashrae_140.csv +8 -8
  619. data/example_files/resources/hpxml-measures/workflow/tests/base_results/results_bills.csv +444 -410
  620. data/example_files/resources/hpxml-measures/workflow/tests/compare.py +18 -4
  621. data/example_files/resources/hpxml-measures/workflow/tests/hpxml_translator_test.rb +133 -288
  622. data/example_files/scripts/convert_urbanopt_to_disco.py +130 -0
  623. data/example_files/scripts/default_control_changes.csv +8 -0
  624. data/example_files/scripts/default_voltage_regulators.csv +3 -0
  625. data/example_files/scripts/read_data.py +331 -0
  626. data/example_files/visualization/input_visualization_feature.html +172 -81
  627. data/example_files/visualization/input_visualization_scenario.html +178 -82
  628. data/example_files/xml_building/17/README.md +2 -2
  629. data/example_files/xml_building/17/unit 1.xml +40 -41
  630. data/example_files/xml_building/17/unit 2.xml +35 -36
  631. data/example_files/xml_building/17/unit 3.xml +35 -36
  632. data/example_files/xml_building/17/unit 4.xml +41 -42
  633. data/lib/uo_cli/version.rb +1 -1
  634. data/lib/uo_cli.rb +596 -96
  635. data/uo_cli.gemspec +6 -5
  636. metadata +121 -36
  637. data/example_files/residential/exhaust.tsv +0 -3
  638. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv +0 -493
  639. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/data/water_heater_efficiency.csv +0 -157
  640. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_schematron/HPXMLvalidator.xml +0 -620
  641. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/validator.rb +0 -107
  642. data/example_files/resources/hpxml-measures/ReportHPXMLOutput/measure.rb +0 -450
  643. data/example_files/resources/hpxml-measures/ReportHPXMLOutput/measure.xml +0 -85
  644. data/example_files/resources/hpxml-measures/ReportHPXMLOutput/resources/constants.rb +0 -72
  645. data/example_files/resources/hpxml-measures/ReportHPXMLOutput/tests/hpxml_output_report_test.rb +0 -290
  646. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/PV_10kW.csv +0 -8761
  647. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/PV_1kW.csv +0 -8761
  648. data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/PV_None.csv +0 -8761
  649. data/example_files/resources/hpxml-measures/workflow/tests/base_results/results_hvac_sizing.csv +0 -410
@@ -13,25 +13,21 @@ Using HPXML
13
13
  HPXML is an flexible and extensible format, where nearly all elements in the schema are optional and custom elements can be included.
14
14
  Because of this, a stricter set of requirements for the HPXML file have been developed for purposes of running EnergyPlus simulations.
15
15
 
16
- HPXML files submitted to OpenStudio-HPXML should undergo a two step validation process:
16
+ HPXML files submitted to OpenStudio-HPXML undergo a two step validation process:
17
17
 
18
18
  1. Validation against the HPXML Schema
19
19
 
20
20
  The HPXML XSD Schema can be found at ``HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd``.
21
- It should be used by the software developer to validate their HPXML file prior to running the simulation.
22
21
  XSD Schemas are used to validate what elements/attributes/enumerations are available, data types for elements/attributes, the number/order of children elements, etc.
23
22
 
24
- OpenStudio-HPXML **does not** validate the HPXML file against the XSD Schema and assumes the file submitted is valid.
25
- However, OpenStudio-HPXML does automatically check for valid data types (e.g., integer vs string), enumeration choices, and numeric values within min/max.
26
-
27
23
  2. Validation using `Schematron <http://schematron.com/>`_
28
24
 
29
25
  The Schematron document for the EnergyPlus use case can be found at ``HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml``.
30
26
  Schematron is a rule-based validation language, expressed in XML using XPath expressions, for validating the presence or absence of inputs in XML files.
31
27
  As opposed to an XSD Schema, a Schematron document validates constraints and requirements based on conditionals and other logical statements.
32
28
  For example, if an element is specified with a particular value, the applicable enumerations of another element may change.
33
-
34
- OpenStudio-HPXML **automatically validates** the HPXML file against the Schematron document and reports any validation errors, but software developers may find it beneficial to also integrate Schematron validation into their software.
29
+
30
+ OpenStudio-HPXML **automatically validates** the HPXML file against both the XSD and Schematron documents and reports any validation errors, but software developers may find it beneficial to also integrate validation into their software.
35
31
 
36
32
  .. important::
37
33
 
@@ -91,32 +87,24 @@ HPXML Simulation Control
91
87
 
92
88
  EnergyPlus simulation controls are entered in ``/HPXML/SoftwareInfo/extension/SimulationControl``.
93
89
 
94
- ================================== ======== ======= ============= ======== =========================== =====================================
95
- Element Type Units Constraints Required Default Description
96
- ================================== ======== ======= ============= ======== =========================== =====================================
97
- ``Timestep`` integer minutes Divisor of 60 No 60 (1 hour) Timestep
98
- ``BeginMonth`` integer 1 - 12 [#]_ No 1 (January) Run period start date
99
- ``BeginDayOfMonth`` integer 1 - 31 No 1 Run period start date
100
- ``EndMonth`` integer 1 - 12 No 12 (December) Run period end date
101
- ``EndDayOfMonth`` integer 1 - 31 No 31 Run period end date
102
- ``CalendarYear`` integer > 1600 [#]_ No 2007 (for TMY weather) [#]_ Calendar year (for start day of week)
103
- ``DaylightSaving/Enabled`` boolean No true Daylight saving enabled?
104
- ================================== ======== ======= ============= ======== =========================== =====================================
90
+ ==================================== ======== ======= ============= ======== =========================== =====================================
91
+ Element Type Units Constraints Required Default Description
92
+ ==================================== ======== ======= ============= ======== =========================== =====================================
93
+ ``Timestep`` integer minutes Divisor of 60 No 60 (1 hour) Timestep
94
+ ``BeginMonth`` integer 1 - 12 [#]_ No 1 (January) Run period start date
95
+ ``BeginDayOfMonth`` integer 1 - 31 No 1 Run period start date
96
+ ``EndMonth`` integer 1 - 12 No 12 (December) Run period end date
97
+ ``EndDayOfMonth`` integer 1 - 31 No 31 Run period end date
98
+ ``CalendarYear`` integer > 1600 [#]_ No 2007 (for TMY weather) [#]_ Calendar year (for start day of week)
99
+ ``TemperatureCapacitanceMultiplier`` double > 0 No 1.0 Multiplier on air heat capacitance [#]_
100
+ ==================================== ======== ======= ============= ======== =========================== =====================================
105
101
 
106
102
  .. [#] BeginMonth/BeginDayOfMonth date must occur before EndMonth/EndDayOfMonth date (e.g., a run period from 10/1 to 3/31 is invalid).
107
103
  .. [#] If a leap year is specified (e.g., 2008), the EPW weather file must contain 8784 hours.
108
104
  .. [#] CalendarYear only applies to TMY (Typical Meteorological Year) weather. For AMY (Actual Meteorological Year) weather, the AMY year will be used regardless of what is specified.
109
-
110
- If daylight saving is enabled, additional information is specified in ``DaylightSaving``.
111
-
112
- ====================================== ======== ===== ================= ======== ============================= ===========
113
- Element Type Units Constraints Required Default Description
114
- ====================================== ======== ===== ================= ======== ============================= ===========
115
- ``BeginMonth`` and ``BeginDayOfMonth`` integer 1 - 12 and 1 - 31 No EPW else 3/12 (March 12) [#]_ Start date
116
- ``EndMonth`` and ``EndDayOfMonth`` integer 1 - 12 and 1 - 31 No EPW else 11/5 (November 5) End date
117
- ====================================== ======== ===== ================= ======== ============================= ===========
118
-
119
- .. [#] Daylight saving dates will be defined according to the EPW weather file header; if not available, fallback default values listed above will be used.
105
+ .. [#] TemperatureCapacitanceMultiplier affects the transient calculation of indoor air temperatures.
106
+ Values greater than 1.0 have the effect of smoothing or damping the rate of change in the indoor air temperature from timestep to timestep.
107
+ This heat capacitance effect is modeled on top of any other individual mass inputs (e.g., furniture mass, partition wall mass, interior drywall, etc.) in the HPXML.
120
108
 
121
109
  HPXML HVAC Sizing Control
122
110
  *************************
@@ -193,12 +181,17 @@ The column names available in the schedule CSV files are:
193
181
  ``cooling_setpoint`` F Thermostat cooling setpoint schedule. No
194
182
  ``water_heater_setpoint`` F Water heater setpoint schedule. No
195
183
  ``water_heater_operating_mode`` 0/1 Heat pump water heater operating mode schedule. 0=standard, 1=heat pump only. No
184
+ ``battery`` frac Battery schedule. Positive for charging, negative for discharging. No
196
185
  ``vacancy`` 0/1 Vacancy schedule. 0=occupied, 1=vacant. Automatically overrides other columns. N/A
197
186
  =============================== ===== ============================================================================== ===================
198
187
 
199
188
  Columns with units of `frac` must be normalized to MAX=1; that is, these schedules only define *when* energy is used, not *how much* energy is used.
200
189
  Example schedule CSV files are provided in the ``HPXMLtoOpenStudio/resources/schedule_files`` directory.
201
190
 
191
+ The schedule file must have a full year of data even if the simulation is not an entire year.
192
+ Frequency of schedule values do not need to match the simulation timestep.
193
+ For example, hourly schedules can be used with a 10-minute simulation timestep, or 10-minute schedules can be used with an hourly simulation timestep.
194
+
202
195
  A detailed stochastic or smooth occupancy schedule CSV file can also be automatically generated for you; see the :ref:`usage_instructions` for the commands.
203
196
  Inputs for the schedule generator are entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/BuildingOccupancy/NumberofResidents`` and ``/HPXML/Building/Site/Address/StateCode``.
204
197
  See :ref:`buildingoccupancy` and :ref:`buildingsite` for more information.
@@ -290,8 +283,6 @@ Default Values
290
283
  ~~~~~~~~~~~~~~
291
284
 
292
285
  If EmissionsType is "CO2e", "NOx" or "SO2" and a given fuel's emissions factor is not entered, they will be defaulted as follows.
293
- Values are based on ANSI/RESNET/ICC 301 and include both combustion and pre-combustion (e.g., methane leakage for natural gas) emissions.
294
- If no default value is available, a warning will be issued.
295
286
 
296
287
  ============ ============== ============= =============
297
288
  Fuel Type CO2e [lb/MBtu] NOx [lb/MBtu] SO2 [lb/MBtu]
@@ -304,6 +295,130 @@ If no default value is available, a warning will be issued.
304
295
  wood pellets -- -- --
305
296
  ============ ============== ============= =============
306
297
 
298
+ Default values are from *Table 5.1.2(1) National Average Emission Factors for Household Fuels* from *ANSI/RESNET/ICCC 301 Standard for the Calculation and Labeling of the Energy Performance of Dwelling and Sleeping Units using an Energy Rating Index* and include both combustion and pre-combustion (e.g., methane leakage for natural gas) emissions.
299
+
300
+ If no default value is available, a warning will be issued.
301
+
302
+ HPXML Utility Bill Scenarios
303
+ ****************************
304
+
305
+ One or more utility bill scenarios can be entered as an ``/HPXML/SoftwareInfo/extension/UtilityBillScenarios/UtilityBillScenario``.
306
+
307
+ ================================ ======== ===== =========== ======== ======== ============================================================
308
+ Element Type Units Constraints Required Default Notes
309
+ ================================ ======== ===== =========== ======== ======== ============================================================
310
+ ``Name`` string Yes Name of the scenario (which shows up in the output file)
311
+ ``UtilityRate`` element >= 0 Utility rate(s) for a given fuel type
312
+ ``PVCompensation`` element <= 1 PV compensation information
313
+ ================================ ======== ===== =========== ======== ======== ============================================================
314
+
315
+ See :ref:`bill_outputs` for a description of how the calculated utility bills appear in the output files.
316
+
317
+ Electricity Rates
318
+ ~~~~~~~~~~~~~~~~~
319
+
320
+ For each scenario, electricity rates can be optionally entered as an ``/HPXML/SoftwareInfo/extension/UtilityBillScenarios/UtilityBillScenario/UtilityRate``.
321
+ Electricity rates can be entered using Simple inputs or Detailed inputs.
322
+
323
+ **Simple**
324
+
325
+ For simple utility rate structures, inputs can be entered using a fixed charge and a marginal rate.
326
+
327
+ ================================ ======== ======= =========== ======== ======== ============================================================
328
+ Element Type Units Constraints Required Default Notes
329
+ ================================ ======== ======= =========== ======== ======== ============================================================
330
+ ``FuelType`` string electricity Yes Fuel type
331
+ ``FixedCharge`` double $/month No 12.0 Monthly fixed charge
332
+ ``MarginalRate`` double $/kWh No See [#]_ Marginal flat rate
333
+ ================================ ======== ======= =========== ======== ======== ============================================================
334
+
335
+ .. [#] If MarginalRate not provided, defaults to state, regional, or national average based on EIA data that can be found at ``ReportUtilityBills/resources/Data/UtilityRates/Average_retail_price_of_electricity.csv``.
336
+
337
+ **Detailed**
338
+
339
+ For detailed utility rate structures, inputs can be entered using a tariff JSON file.
340
+
341
+ ================================ ======== ======= =========== ======== ======== ============================================================
342
+ Element Type Units Constraints Required Default Notes
343
+ ================================ ======== ======= =========== ======== ======== ============================================================
344
+ ``FuelType`` string electricity Yes Fuel type
345
+ ``TariffFilePath`` string Yes Path to tariff JSON file [#]_
346
+ ================================ ======== ======= =========== ======== ======== ============================================================
347
+
348
+ .. [#] TariffFilePath must point to a JSON file with utility rate structure information.
349
+ Tariff files can describe flat, tiered, time-of-use, tiered time-of-use, or real-time pricing rates.
350
+ Sources of tariff files include `OpenEI's U.S. Utility Rate Database (URDB) <https://openei.org/wiki/Utility_Rate_Database>`_;
351
+ a large set of residential OpenEI URDB rates for U.S. utilities are included at ``ReportUtilityBills/resources/detailed_rates/openei_rates.zip``.
352
+ Additional sample tariff files can be found in ``ReportUtilityBills/resources/detailed_rates``.
353
+ Tariff files are formatted based on `OpenEI API version 7 <https://openei.org/services/doc/rest/util_rates/?version=7#response-fields>`_.
354
+
355
+ Fuel Rates
356
+ ~~~~~~~~~~
357
+
358
+ For each scenario, fuel rates can be optionally entered as an ``/HPXML/SoftwareInfo/extension/UtilityBillScenarios/UtilityBillScenario/UtilityRate``.
359
+
360
+ ================================ ======== ======== =========== ======== ======== ============================================================
361
+ Element Type Units Constraints Required Default Notes
362
+ ================================ ======== ======== =========== ======== ======== ============================================================
363
+ ``FuelType`` string See [#]_ Yes Fuel type
364
+ ``FixedCharge`` double $/month No See [#]_ Monthly fixed charge
365
+ ``MarginalRate`` double See [#]_ No See [#]_ Marginal flat rate
366
+ ================================ ======== ======== =========== ======== ======== ============================================================
367
+
368
+ .. [#] FuelType choices are "natural gas", "propane", "fuel oil", "coal", "wood", and "wood pellets".
369
+ .. [#] FixedCharge defaults to $12/month for natural gas and $0/month for other fuels.
370
+ .. [#] MarginalRate units are $/therm for natural gas, $/gallon for propane and fuel oil, and $/kBtu for other fuels.
371
+ .. [#] If MarginalRate not provided, defaults to state, regional, or national average based on EIA data that can be found at:
372
+
373
+ - natural gas: ``ReportUtilityBills/resources/Data/UtilityRates/NG_PRI_SUM_A_EPG0_PRS_DMCF_A.csv``
374
+ - propane: ``ReportUtilityBills/resources/Data/UtilityRates/PET_PRI_WFR_A_EPLLPA_PRS_DPGAL_W.csv``
375
+ - fuel oil: ``ReportUtilityBills/resources/Data/UtilityRates/PET_PRI_WFR_A_EPD2F_PRS_DPGAL_W.csv``
376
+
377
+ or defaults to $0.015/kBtu for other fuels.
378
+
379
+ PV Compensation
380
+ ~~~~~~~~~~~~~~~
381
+
382
+ For each scenario, PV compensation information can be optionally entered in ``/HPXML/SoftwareInfo/extension/UtilityBillScenarios/UtilityBillScenario/PVCompensation``.
383
+
384
+ ============================================================= ======== ======= =========== ======== ============== ==============================
385
+ Element Type Units Constraints Required Default Notes
386
+ ============================================================= ======== ======= =========== ======== ============== ==============================
387
+ ``CompensationType[NetMetering | FeedInTariff]`` element No NetMetering PV compensation type
388
+ ``MonthlyGridConnectionFee[Units="$/kW" or Units="$"]/Value`` double No 0 PV monthly grid connection fee
389
+ ============================================================= ======== ======= =========== ======== ============== ==============================
390
+
391
+ **Net-Metering**
392
+
393
+ If the PV compensation type is net-metering, additional information can be entered in ``/HPXML/SoftwareInfo/extension/UtilityBillScenarios/UtilityBillScenario/PVCompensation/CompensationType/NetMetering``.
394
+
395
+ ================================ ======== ======= =========== ======== ============== =============================================================
396
+ Element Type Units Constraints Required Default Notes
397
+ ================================ ======== ======= =========== ======== ============== =============================================================
398
+ ``AnnualExcessSellbackRateType`` string See [#]_ No User-Specified Net metering annual excess sellback rate type [#]_
399
+ ``AnnualExcessSellbackRate`` double $/kWh No [#]_ 0.03 User-specified net metering annual excess sellback rate [#]_
400
+ ================================ ======== ======= =========== ======== ============== =============================================================
401
+
402
+ .. [#] AnnualExcessSellbackRateType choices are "User-Specified" and "Retail Electricity Cost".
403
+ .. [#] When annual PV production exceeds the annual building electricity consumption, this rate, which is often significantly below the retail rate, determines the value of the excess electricity sold back to the utility.
404
+ This may happen to offset gas consumption, for example.
405
+ .. [#] AnnualExcessSellbackRate is only used when AnnualExcessSellbackRateType="User-Specified".
406
+ .. [#] Since modeled electricity consumption will not change from one year to the next, "indefinite rollover" of annual excess generation credit is best approximated by setting "User-Specified" and entering a rate of zero.
407
+
408
+ **Feed-in Tariff**
409
+
410
+ If the PV compensation type is feed-in tariff, additional information can be entered in ``/HPXML/SoftwareInfo/extension/UtilityBillScenarios/UtilityBillScenario/PVCompensation/CompensationType/FeedInTariff``.
411
+
412
+ ============================ ======== ======= =========== ======== ============== =============================================================
413
+ Element Type Units Constraints Required Default Notes
414
+ ============================ ======== ======= =========== ======== ============== =============================================================
415
+ ``FeedInTariffRate`` double $/kWh No 0.12 Feed-in tariff rate [#]_
416
+ ============================ ======== ======= =========== ======== ============== =============================================================
417
+
418
+ .. [#] FeedInTariffRate applies to full (not excess) PV production.
419
+ Some utilities/regions may have a feed-in tariff policy where compensation occurs for excess PV production (i.e., PV-generated electricity sent to the grid that is not immediately consumed by the building), rather than full PV production.
420
+ OpenStudio-HPXML is currently unable to calculate utility bills for such a feed-in tariff policy.
421
+
307
422
  .. _buildingsite:
308
423
 
309
424
  HPXML Building Site
@@ -319,6 +434,7 @@ Building site information can be entered in ``/HPXML/Building/Site``.
319
434
  ``Address/StateCode`` string No See [#]_ State/territory where the home is located
320
435
  ``Address/ZipCode`` string See [#]_ No ZIP Code where the home is located
321
436
  ``TimeZone/UTCOffset`` double See [#]_ No See [#]_ Difference in decimal hours between the home's time zone and UTC
437
+ ``TimeZone/DSTObserved`` boolean No true Daylight saving time observed?
322
438
  ======================================= ======== ===== =========== ======== ======== ===============
323
439
 
324
440
  .. [#] If StateCode not provided, defaults according to the EPW weather file header.
@@ -326,6 +442,17 @@ Building site information can be entered in ``/HPXML/Building/Site``.
326
442
  .. [#] UTCOffset ranges from -12 to 14.
327
443
  .. [#] If UTCOffset not provided, defaults according to the EPW weather file header.
328
444
 
445
+ If daylight saving time is observed, additional information can be specified in ``/HPXML/Building/Site/TimeZone/extension``.
446
+
447
+ ============================================ ======== ===== ================= ======== ============================= ===========
448
+ Element Type Units Constraints Required Default Description
449
+ ============================================ ======== ===== ================= ======== ============================= ===========
450
+ ``DSTBeginMonth`` and ``DSTBeginDayOfMonth`` integer 1 - 12 and 1 - 31 No EPW else 3/12 (March 12) [#]_ Start date
451
+ ``DSTEndMonth`` and ``DSTEndDayOfMonth`` integer 1 - 12 and 1 - 31 No EPW else 11/5 (November 5) End date
452
+ ============================================ ======== ===== ================= ======== ============================= ===========
453
+
454
+ .. [#] Daylight saving dates will be defined according to the EPW weather file header; if not available, fallback default values listed above will be used.
455
+
329
456
  HPXML Building Summary
330
457
  ----------------------
331
458
 
@@ -336,16 +463,18 @@ HPXML Site
336
463
 
337
464
  Site information is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/Site``.
338
465
 
339
- ================================ ======== ===== =========== ======== ======== ============================================================
340
- Element Type Units Constraints Required Default Notes
341
- ================================ ======== ===== =========== ======== ======== ============================================================
342
- ``SiteType`` string See [#]_ No suburban Terrain type for infiltration model
343
- ``ShieldingofHome`` string See [#]_ No normal Presence of nearby buildings, trees, obstructions for infiltration model
344
- ``extension/Neighbors`` element >= 0 No <none> Presence of neighboring buildings for solar shading
345
- ================================ ======== ===== =========== ======== ======== ============================================================
466
+ ================================ ======== =========== =========== ======== ======== ============================================================
467
+ Element Type Units Constraints Required Default Notes
468
+ ================================ ======== =========== =========== ======== ======== ============================================================
469
+ ``SiteType`` string See [#]_ No suburban Terrain type for infiltration model
470
+ ``ShieldingofHome`` string See [#]_ No normal Presence of nearby buildings, trees, obstructions for infiltration model
471
+ ``extension/GroundConductivity`` double Btu/hr-ft-F > 0 No 1.0 Thermal conductivity of the ground soil [#]_
472
+ ``extension/Neighbors`` element >= 0 No <none> Presence of neighboring buildings for solar shading
473
+ ================================ ======== =========== =========== ======== ======== ============================================================
346
474
 
347
475
  .. [#] SiteType choices are "rural", "suburban", or "urban".
348
476
  .. [#] ShieldingofHome choices are "normal", "exposed", or "well-shielded".
477
+ .. [#] GroundConductivity used for foundation heat transfer and ground source heat pumps.
349
478
 
350
479
  For each neighboring building defined, additional information is entered in a ``extension/Neighbors/NeighborBuilding``.
351
480
 
@@ -370,7 +499,7 @@ Building occupancy is entered in ``/HPXML/Building/BuildingDetails/BuildingSumma
370
499
  ======================================== ======== ===== =========== ======== ==================== ========================
371
500
  Element Type Units Constraints Required Default Notes
372
501
  ======================================== ======== ===== =========== ======== ==================== ========================
373
- ``NumberofResidents`` integer >= 0 See [#]_ <number of bedrooms> Number of occupants [#]_
502
+ ``NumberofResidents`` double >= 0 See [#]_ <number of bedrooms> Number of occupants [#]_
374
503
  ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
375
504
  ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
376
505
  ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
@@ -416,19 +545,19 @@ HPXML Climate Zones
416
545
  HPXML Climate Zone IECC
417
546
  ***********************
418
547
 
419
- Climate zone information can be entered as an ``/HPXML/Building/BuildingDetails/ClimateandRiskZones/ClimateZoneIECC``.
548
+ Climate zone information can be optionally entered as an ``/HPXML/Building/BuildingDetails/ClimateandRiskZones/ClimateZoneIECC``.
420
549
 
421
550
  ================================= ======== ===== =========== ======== ======== ===============
422
551
  Element Type Units Constraints Required Default Description
423
552
  ================================= ======== ===== =========== ======== ======== ===============
424
- ``Year`` integer See [#]_ No 2006 IECC year
425
- ``ClimateZone`` string See [#]_ No See [#]_ IECC zone
553
+ ``Year`` integer See [#]_ Yes IECC year
554
+ ``ClimateZone`` string See [#]_ Yes IECC zone
426
555
  ================================= ======== ===== =========== ======== ======== ===============
427
556
 
428
- .. [#] Year choices are 2003, 2006, 2009, or 2012.
557
+ .. [#] Year choices are 2003, 2006, 2009, 2012, 2015, 2018, or 2021.
429
558
  .. [#] ClimateZone choices are "1A", "1B", "1C", "2A", "2B", "2C", "3A", "3B", "3C", "4A", "4B", "4C", "5A", "5B", "5C", "6A", "6B", "6C", "7", or "8".
430
- .. [#] If ClimateZone not provided, defaults according to the EPW weather file header.
431
559
 
560
+ If Climate zone information not provided, defaults according to the EPW weather file header.
432
561
 
433
562
  Weather information is entered in ``/HPXML/Building/BuildingDetails/ClimateandRiskZones/WeatherStation``.
434
563
 
@@ -522,7 +651,7 @@ HPXML Roofs
522
651
 
523
652
  Each pitched or flat roof surface that is exposed to ambient conditions is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Roofs/Roof``.
524
653
 
525
- For a multifamily building where the dwelling unit has another dwelling unit above it, the surface between the two dwelling units should be considered a ``FrameFloor`` and not a ``Roof``.
654
+ For a multifamily building where the dwelling unit has another dwelling unit above it, the surface between the two dwelling units should be considered a ``Floor`` and not a ``Roof``.
526
655
 
527
656
  ====================================== ================= ================ ===================== ========= ============================== ==================================
528
657
  Element Type Units Constraints Required Default Notes
@@ -632,7 +761,7 @@ Each wall that has no contact with the ground and bounds a space type is entered
632
761
  See :ref:`hpxmllocations` for descriptions.
633
762
  .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "crawlspace - conditioned", or "garage".
634
763
  See :ref:`hpxmllocations` for descriptions.
635
- .. [#] WallType child element choices are ``WoodStud``, ``DoubleWoodStud``, ``ConcreteMasonryUnit``, ``StructurallyInsulatedPanel``, ``InsulatedConcreteForms``, ``SteelFrame``, ``SolidConcrete``, ``StructuralBrick``, ``StrawBale``, ``Stone``, ``LogWall``, or ``Adobe``.
764
+ .. [#] WallType child element choices are ``WoodStud``, ``DoubleWoodStud``, ``ConcreteMasonryUnit``, ``StructuralInsulatedPanel``, ``InsulatedConcreteForms``, ``SteelFrame``, ``SolidConcrete``, ``StructuralBrick``, ``StrawBale``, ``Stone``, ``LogWall``, or ``Adobe``.
636
765
  .. [#] Orientation choices are "northeast", "east", "southeast", "south", "southwest", "west", "northwest", or "north"
637
766
  .. [#] If neither Azimuth nor Orientation provided, and it's an *exterior* wall, modeled as four surfaces of equal area facing every direction.
638
767
  Azimuth/Orientation is irrelevant for *interior* walls (e.g., between living space and garage).
@@ -710,10 +839,10 @@ If insulation layers are provided, additional information is entered in each ``F
710
839
 
711
840
  .. [#] When NominalRValue is non-zero, DistanceToBottomOfInsulation must be greater than DistanceToTopOfInsulation and less than or equal to FoundationWall/Height.
712
841
 
713
- HPXML Frame Floors
842
+ HPXML Floors
714
843
  ******************
715
844
 
716
- Each floor/ceiling surface that is not in contact with the ground (Slab) nor adjacent to ambient conditions above (Roof) is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/FrameFloors/FrameFloor``.
845
+ Each floor/ceiling surface that is not in contact with the ground (Slab) nor adjacent to ambient conditions above (Roof) is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Floors/Floor``.
717
846
 
718
847
  ====================================== ======== ============ =========== ======== ======== ============================
719
848
  Element Type Units Constraints Required Default Notes
@@ -721,6 +850,7 @@ Each floor/ceiling surface that is not in contact with the ground (Slab) nor adj
721
850
  ``SystemIdentifier`` id Yes Unique identifier
722
851
  ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type
723
852
  ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
853
+ ``FloorType`` element 1 [#]_ Yes Floor type (for thermal mass)
724
854
  ``Area`` double ft2 > 0 Yes Gross area
725
855
  ``InteriorFinish/Type`` string See [#]_ No See [#]_ Interior finish material
726
856
  ``InteriorFinish/Thickness`` double in >= 0 No 0.5 Interior finish thickness
@@ -732,19 +862,20 @@ Each floor/ceiling surface that is not in contact with the ground (Slab) nor adj
732
862
  See :ref:`hpxmllocations` for descriptions.
733
863
  .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "crawlspace - conditioned", or "garage".
734
864
  See :ref:`hpxmllocations` for descriptions.
865
+ .. [#] FloorType child element choices are ``WoodFrame``, ``StructuralInsulatedPanel``, ``SteelFrame``, or ``SolidConcrete``.
735
866
  .. [#] InteriorFinish/Type choices are "gypsum board", "gypsum composite board", "plaster", "wood", "other", or "none".
736
867
  .. [#] InteriorFinish/Type defaults to "gypsum board" if InteriorAdjacentTo is living space and the surface is a ceiling, otherwise "none".
737
868
  .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
738
869
 
739
- For frame floors adjacent to "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space", additional information is entered in ``FrameFloor``.
870
+ For floors adjacent to "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space", additional information is entered in ``Floor``.
740
871
 
741
872
  ====================================== ======== ===== ============== ======== ======= ==========================================
742
873
  Element Type Units Constraints Required Default Notes
743
874
  ====================================== ======== ===== ============== ======== ======= ==========================================
744
- ``extension/OtherSpaceAboveOrBelow`` string See [#]_ Yes Specifies if above/below the MF space type
875
+ ``FloorOrCeiling`` string See [#]_ Yes Specifies whether a floor or ceiling from the perspective of the conditioned space
745
876
  ====================================== ======== ===== ============== ======== ======= ==========================================
746
877
 
747
- .. [#] OtherSpaceAboveOrBelow choices are "above" or "below".
878
+ .. [#] FloorOrCeiling choices are "floor" or "ceiling".
748
879
 
749
880
  HPXML Slabs
750
881
  ***********
@@ -762,7 +893,7 @@ Each space type that borders the ground (i.e., basements, crawlspaces, garages,
762
893
  ``DepthBelowGrade`` double ft >= 0 See [#]_ Depth from the top of the slab surface to grade
763
894
  ``PerimeterInsulation/SystemIdentifier`` id Yes Unique identifier
764
895
  ``PerimeterInsulation/Layer/NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of vertical insulation
765
- ``PerimeterInsulation/Layer/InsulationDepth`` double ft >= 0 Yes Depth from grade to bottom of vertical insulation
896
+ ``PerimeterInsulation/Layer/InsulationDepth`` double ft >= 0 Yes Depth from top of slab to bottom of vertical insulation
766
897
  ``UnderSlabInsulation/SystemIdentifier`` id Yes Unique identifier
767
898
  ``UnderSlabInsulation/Layer/NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of horizontal insulation
768
899
  ``UnderSlabInsulation/Layer/InsulationWidth`` double ft >= 0 See [#]_ Width from slab edge inward of horizontal insulation
@@ -824,6 +955,16 @@ Each window or glass door area is entered as an ``/HPXML/Building/BuildingDetail
824
955
  The total open window area for natural ventilation is calculated using A) the operable fraction, B) the assumption that 50% of the area of operable windows can be open, and C) the assumption that 20% of that openable area is actually opened by occupants whenever outdoor conditions are favorable for cooling.
825
956
  .. [#] AttachedToWall must reference a ``Wall`` or ``FoundationWall``.
826
957
 
958
+ If operable windows are defined, the availability of natural ventilation is entered in ``/HPXML/SoftwareInfo/extension``.
959
+
960
+ ============================================= ======== ========= =========== ======== ======== ========================================================
961
+ Element Type Units Constraints Required Default Notes
962
+ ============================================= ======== ========= =========== ======== ======== ========================================================
963
+ ``NaturalVentilationAvailabilityDaysperWeek`` integer days/week 0 - 7 No 3 [#]_ How often windows can be opened by occupants for natural ventilation
964
+ ============================================= ======== ========= =========== ======== ======== ========================================================
965
+
966
+ .. [#] Default of 3 days per week (Monday/Wednesday/Friday) is based on `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
967
+
827
968
  If UFactor and SHGC are not provided and GlassLayers is not "glass block", additional information is entered in ``Window``.
828
969
 
829
970
  ============================ ======== ====== ======================= ======== ======== ========================================================
@@ -1036,11 +1177,10 @@ Each heating system (other than a heat pump) is entered as an ``/HPXML/Building/
1036
1177
  ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ See [#]_ Fraction of heating load served
1037
1178
  ================================= ======== ====== =========== ======== ========= ===============================
1038
1179
 
1039
- .. [#] HeatingSystemType child element choices are ``ElectricResistance``, ``Furnace``, ``WallFurnace``, ``FloorFurnace``, ``Boiler``, ``Stove``, ``PortableHeater``, ``FixedHeater``, ``Fireplace``, or ``PackagedTerminalAirConditionerHeating``.
1180
+ .. [#] HeatingSystemType child element choices are ``ElectricResistance``, ``Furnace``, ``WallFurnace``, ``FloorFurnace``, ``Boiler``, ``Stove``, ``PortableHeater``, ``FixedHeater``, or ``Fireplace``.
1040
1181
  .. [#] HeatingSystemFuel choices are "electricity", "natural gas", "fuel oil", "fuel oil 1", "fuel oil 2", "fuel oil 4", "fuel oil 5/6", "diesel", "propane", "kerosene", "coal", "coke", "bituminous coal", "wood", or "wood pellets".
1041
1182
  For ``ElectricResistance``, "electricity" is required.
1042
- For ``PackagedTerminalAirConditionerHeating``, "electricity" is currently the only choice.
1043
- .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
1183
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1044
1184
  .. [#] FractionHeatLoadServed is required unless the heating system is a heat pump backup system (i.e., referenced by a ``HeatPump[BackupType="separate"]/BackupSystem``; see :ref:`hvac_heatpump`), in which case FractionHeatLoadServed is not allowed.
1045
1185
 
1046
1186
  Electric Resistance
@@ -1051,40 +1191,24 @@ If electric resistance heating is specified, additional information is entered i
1051
1191
  ================================================== ====== ===== =========== ======== ======= ==========
1052
1192
  Element Type Units Constraints Required Default Notes
1053
1193
  ================================================== ====== ===== =========== ======== ======= ==========
1054
- ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 No 1.0 Efficiency
1194
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
1055
1195
  ================================================== ====== ===== =========== ======== ======= ==========
1056
1196
 
1057
- PTAC Heating
1058
- ~~~~~~~~~~~~
1059
-
1060
- If a PTAC with non-heat pump (e.g., electric resistance) heating is specified, additional information is entered in ``HeatingSystem``.
1061
-
1062
- ================================================== ====== ========= =========== ======== ======= ==================================
1063
- Element Type Units Constraints Required Default Notes
1064
- ================================================== ====== ========= =========== ======== ======= ==================================
1065
- ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 No 1.0 Efficiency
1066
- ================================================== ====== ========= =========== ======== ======= ==================================
1067
-
1068
- .. note::
1069
-
1070
- A cooling system of type "packaged terminal air conditioner" must be specified in ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/CoolingSystem``.
1071
-
1072
1197
  Furnace
1073
1198
  ~~~~~~~
1074
1199
 
1075
1200
  If a furnace is specified, additional information is entered in ``HeatingSystem``.
1076
1201
 
1077
- ==================================================================== ================= ========= =============== ======== ======== ================================================
1078
- Element Type Units Constraints Required Default Notes
1079
- ==================================================================== ================= ========= =============== ======== ======== ================================================
1080
- ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1081
- ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` or ``YearInstalled`` double or integer frac or # 0 - 1 or > 1600 Yes See [#]_ Rated efficiency or Year installed
1082
- ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed [#]_
1083
- ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1084
- ==================================================================== ================= ========= =============== ======== ======== ================================================
1202
+ =============================================== ====== ========= =========== ======== ======== ================================================
1203
+ Element Type Units Constraints Required Default Notes
1204
+ =============================================== ====== ========= =========== ======== ======== ================================================
1205
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1206
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0 - 1 Yes Rated efficiency
1207
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed [#]_
1208
+ ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1209
+ =============================================== ====== ========= =========== ======== ======== ================================================
1085
1210
 
1086
1211
  .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity" or "gravity") or DSE.
1087
- .. [#] If AnnualHeatingEfficiency[Units="AFUE"]/Value not provided, defaults to 0.98 if FuelType is "electricity", else AFUE from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv`` based on YearInstalled.
1088
1212
  .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0 W/cfm if gravity distribution system, else 0.5 W/cfm if AFUE <= 0.9, else 0.375 W/cfm.
1089
1213
  .. [#] If there is a cooling system attached to the DistributionSystem, the heating and cooling systems cannot have different values for FanPowerWattsPerCFM.
1090
1214
  .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
@@ -1095,14 +1219,12 @@ Wall/Floor Furnace
1095
1219
 
1096
1220
  If a wall furnace or floor furnace is specified, additional information is entered in ``HeatingSystem``.
1097
1221
 
1098
- ==================================================================== ================= ========= =============== ======== ======== ==================================
1099
- Element Type Units Constraints Required Default Notes
1100
- ==================================================================== ================= ========= =============== ======== ======== ==================================
1101
- ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` or ``YearInstalled`` double or integer frac or # 0 - 1 or > 1600 Yes See [#]_ Rated efficiency or Year installed
1102
- ``extension/FanPowerWatts`` double W >= 0 No 0 Fan power
1103
- ==================================================================== ================= ========= =============== ======== ======== ==================================
1104
-
1105
- .. [#] If AnnualHeatingEfficiency[Units="AFUE"]/Value not provided, defaults to 0.98 if FuelType is "electricity", else AFUE from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv`` based on YearInstalled.
1222
+ =============================================== ====== ===== =========== ======== ======== ================
1223
+ Element Type Units Constraints Required Default Notes
1224
+ =============================================== ====== ===== =========== ======== ======== ================
1225
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0 - 1 Yes Rated efficiency
1226
+ ``extension/FanPowerWatts`` double W >= 0 No 0 Fan power
1227
+ =============================================== ====== ===== =========== ======== ======== ================
1106
1228
 
1107
1229
  .. _hvac_heating_boiler:
1108
1230
 
@@ -1111,18 +1233,17 @@ Boiler
1111
1233
 
1112
1234
  If a boiler is specified, additional information is entered in ``HeatingSystem``.
1113
1235
 
1114
- ==================================================================== ================= ========= =============== ======== ======== =========================================
1115
- Element Type Units Constraints Required Default Notes
1116
- ==================================================================== ================= ========= =============== ======== ======== =========================================
1117
- ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
1118
- ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1119
- ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` or ``YearInstalled`` double or integer frac or # 0 - 1 or > 1600 Yes See [#]_ Rated efficiency or Year installed
1120
- ==================================================================== ================= ========= =============== ======== ======== =========================================
1236
+ =============================================== ======= ========= =========== ======== ======== =========================================
1237
+ Element Type Units Constraints Required Default Notes
1238
+ =============================================== ======= ========= =========== ======== ======== =========================================
1239
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
1240
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1241
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0 - 1 Yes Rated efficiency
1242
+ =============================================== ======= ========= =========== ======== ======== =========================================
1121
1243
 
1122
1244
  .. [#] For in-unit boilers, HVACDistribution type must be HydronicDistribution (type: "radiator", "baseboard", "radiant floor", or "radiant ceiling") or DSE.
1123
1245
  For shared boilers, HVACDistribution type must be HydronicDistribution (type: "radiator", "baseboard", "radiant floor", "radiant ceiling", or "water loop") or AirDistribution (type: "fan coil").
1124
1246
  If the shared boiler has "water loop" distribution, a :ref:`hvac_heatpump_wlhp` must also be specified.
1125
- .. [#] If AnnualHeatingEfficiency[Units="AFUE"]/Value not provided, defaults to 0.98 if FuelType is "electricity", else AFUE from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv`` based on YearInstalled.
1126
1247
 
1127
1248
 
1128
1249
  If an in-unit boiler if specified, additional information is entered in ``HeatingSystem``.
@@ -1164,12 +1285,10 @@ If a stove is specified, additional information is entered in ``HeatingSystem``.
1164
1285
  ================================================== ====== ===== =========== ======== ========= ===================
1165
1286
  Element Type Units Constraints Required Default Notes
1166
1287
  ================================================== ====== ===== =========== ======== ========= ===================
1167
- ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 No See [#]_ Efficiency
1288
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
1168
1289
  ``extension/FanPowerWatts`` double W >= 0 No 40 Fan power
1169
1290
  ================================================== ====== ===== =========== ======== ========= ===================
1170
1291
 
1171
- .. [#] Defaulted to 1.0 if FuelType is "electricity", 0.60 if FuelType is "wood", 0.78 if FuelType is "wood pellets", otherwise 0.81.
1172
-
1173
1292
  Portable/Fixed Heater
1174
1293
  ~~~~~~~~~~~~~~~~~~~~~
1175
1294
 
@@ -1178,12 +1297,10 @@ If a portable heater or fixed heater is specified, additional information is ent
1178
1297
  ================================================== ====== ===== =========== ======== ========= ===================
1179
1298
  Element Type Units Constraints Required Default Notes
1180
1299
  ================================================== ====== ===== =========== ======== ========= ===================
1181
- ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 No See [#]_ Efficiency
1300
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
1182
1301
  ``extension/FanPowerWatts`` double W >= 0 No 0 Fan power
1183
1302
  ================================================== ====== ===== =========== ======== ========= ===================
1184
1303
 
1185
- .. [#] Defaulted to 1.0 if FuelType is "electricity", 0.60 if FuelType is "wood", 0.78 if FuelType is "wood pellets", otherwise 0.81.
1186
-
1187
1304
  Fireplace
1188
1305
  ~~~~~~~~~
1189
1306
 
@@ -1192,12 +1309,10 @@ If a fireplace is specified, additional information is entered in ``HeatingSyste
1192
1309
  ================================================== ====== ===== =========== ======== ========= ===================
1193
1310
  Element Type Units Constraints Required Default Notes
1194
1311
  ================================================== ====== ===== =========== ======== ========= ===================
1195
- ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 No See [#]_ Efficiency
1312
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
1196
1313
  ``extension/FanPowerWatts`` double W >= 0 No 0 Fan power
1197
1314
  ================================================== ====== ===== =========== ======== ========= ===================
1198
1315
 
1199
- .. [#] Defaulted to 1.0 if FuelType is "electricity", 0.60 if FuelType is "wood", 0.78 if FuelType is "wood pellets", otherwise 0.81.
1200
-
1201
1316
  .. _hvac_cooling:
1202
1317
 
1203
1318
  HPXML Cooling Systems
@@ -1216,28 +1331,28 @@ Each cooling system (other than a heat pump) is entered as an ``/HPXML/Building/
1216
1331
 
1217
1332
  .. [#] CoolingSystemType choices are "central air conditioner", "room air conditioner", "evaporative cooler", "mini-split", "chiller", "cooling tower", or "packaged terminal air conditioner".
1218
1333
  .. [#] CoolingSystemFuel only choice is "electricity".
1219
- .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
1334
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1220
1335
 
1221
1336
  Central Air Conditioner
1222
1337
  ~~~~~~~~~~~~~~~~~~~~~~~
1223
1338
 
1224
1339
  If a central air conditioner is specified, additional information is entered in ``CoolingSystem``.
1225
1340
 
1226
- ==================================================================== ================= =========== =============== ======== ========= ================================================
1227
- Element Type Units Constraints Required Default Notes
1228
- ==================================================================== ================= =========== =============== ======== ========= ================================================
1229
- ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1230
- ``AnnualCoolingEfficiency[Units="SEER"]/Value`` or ``YearInstalled`` double or integer Btu/Wh or # > 0 or > 1600 Yes See [#]_ Rated efficiency or Year installed
1231
- ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1232
- ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1233
- ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
1234
- ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed [#]_
1235
- ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1236
- ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1237
- ==================================================================== ================= =========== =============== ======== ========= ================================================
1341
+ ================================================================ ====== =========== =========== ======== ========= ================================================
1342
+ Element Type Units Constraints Required Default Notes
1343
+ ================================================================ ====== =========== =========== ======== ========= ================================================
1344
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1345
+ ``AnnualCoolingEfficiency[Units="SEER" or Units="SEER2"]/Value`` double Btu/Wh or # > 0 Yes Rated efficiency [#]_
1346
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1347
+ ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1348
+ ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
1349
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed [#]_
1350
+ ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1351
+ ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1352
+ ================================================================ ====== =========== =========== ======== ========= ================================================
1238
1353
 
1239
1354
  .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1240
- .. [#] If AnnualCoolingEfficiency[Units="SEER"]/Value not provided, defaults to SEER from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv`` based on YearInstalled.
1355
+ .. [#] If SEER2 provided, converted to SEER using ANSI/RESNET/ICC 301-2022 Addendum C, where SEER = SEER2 / 0.95 (assumed to be a split system).
1241
1356
  .. [#] CompressorType choices are "single stage", "two stage", or "variable speed".
1242
1357
  .. [#] If CompressorType not provided, defaults to "single stage" if SEER <= 15, else "two stage" if SEER <= 21, else "variable speed".
1243
1358
  .. [#] If FanPowerWattsPerCFM not provided, defaults to using attached furnace W/cfm if available, else 0.5 W/cfm if SEER <= 13.5, else 0.375 W/cfm.
@@ -1253,28 +1368,58 @@ Room Air Conditioner
1253
1368
 
1254
1369
  If a room air conditioner is specified, additional information is entered in ``CoolingSystem``.
1255
1370
 
1256
- =================================================================================== ================= =========== =============== ======== ========= ==================================
1257
- Element Type Units Constraints Required Default Notes
1258
- =================================================================================== ================= =========== =============== ======== ========= ==================================
1259
- ``AnnualCoolingEfficiency[Units="EER" or Units="CEER"]/Value`` or ``YearInstalled`` double or integer Btu/Wh or # > 0 or > 1600 Yes See [#]_ Rated efficiency or Year installed
1260
- ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1261
- ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1262
- =================================================================================== ================= =========== =============== ======== ========= ==================================
1371
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1372
+ Element Type Units Constraints Required Default Notes
1373
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1374
+ ``AnnualCoolingEfficiency[Units="EER" or Units="CEER"]/Value`` double Btu/Wh > 0 Yes Rated efficiency
1375
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1376
+ ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1377
+ ``IntegratedHeatingSystemFuel`` string See [#]_ No <none> Fuel type of integrated heater
1378
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1263
1379
 
1264
- .. [#] If AnnualCoolingEfficiency[Units="EER" or Units="CEER"]/Value not provided, defaults to EER from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv`` based on YearInstalled.
1380
+ .. [#] IntegratedHeatingSystemFuel choices are "electricity", "natural gas", "fuel oil", "fuel oil 1", "fuel oil 2", "fuel oil 4", "fuel oil 5/6", "diesel", "propane", "kerosene", "coal", "coke", "bituminous coal", "wood", or "wood pellets".
1381
+
1382
+ If the room air conditioner has integrated heating, additional information is entered in ``CoolingSystem``.
1383
+ Note that a room air conditioner with reverse cycle heating should be entered as a heat pump; see :ref:`room_ac_reverse_cycle`.
1384
+
1385
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1386
+ Element Type Units Constraints Required Default Notes
1387
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1388
+ ``IntegratedHeatingSystemCapacity`` double Btu/hr >= 0 No autosized Heating output capacity of integrated heater
1389
+ ``IntegratedHeatingSystemAnnualEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency of integrated heater
1390
+ ``IntegratedHeatingSystemFractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1391
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1392
+
1393
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1265
1394
 
1266
1395
  Packaged Terminal Air Conditioner
1267
1396
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1268
1397
 
1269
1398
  If a PTAC is specified, additional information is entered in ``CoolingSystem``.
1270
1399
 
1271
- =================================================================== ================= =========== =============== ======== ========= ==================================
1272
- Element Type Units Constraints Required Default Notes
1273
- =================================================================== ================= =========== =============== ======== ========= ==================================
1274
- ``AnnualCoolingEfficiency[Units="EER" or Units="CEER"]/Value`` integer or double # or Btu/Wh > 1600 or > 0 Yes Rated efficiency
1275
- ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1276
- ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1277
- =================================================================== ================= =========== =============== ======== ========= ==================================
1400
+ ================================================================== ====== ====== =========== ======== ========= ==========================================
1401
+ Element Type Units Constraints Required Default Notes
1402
+ ================================================================== ====== ====== =========== ======== ========= ==========================================
1403
+ ``AnnualCoolingEfficiency[Units="EER" or Units="CEER"]/Value`` double Btu/Wh > 0 Yes Rated efficiency
1404
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1405
+ ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1406
+ ``IntegratedHeatingSystemFuel`` string See [#]_ No <none> Fuel type of integrated heater
1407
+ ================================================================== ====== ====== =========== ======== ========= ==========================================
1408
+
1409
+ .. [#] IntegratedHeatingSystemFuel choices are "electricity", "natural gas", "fuel oil", "fuel oil 1", "fuel oil 2", "fuel oil 4", "fuel oil 5/6", "diesel", "propane", "kerosene", "coal", "coke", "bituminous coal", "wood", or "wood pellets".
1410
+
1411
+ If the PTAC has integrated heating, additional information is entered in ``CoolingSystem``.
1412
+ Note that a packaged terminal heat pump should be entered as a heat pump; see :ref:`pthp`.
1413
+
1414
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1415
+ Element Type Units Constraints Required Default Notes
1416
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1417
+ ``IntegratedHeatingSystemCapacity`` double Btu/hr >= 0 No autosized Heating output capacity of integrated heater
1418
+ ``IntegratedHeatingSystemAnnualEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency of integrated heater
1419
+ ``IntegratedHeatingSystemFractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1420
+ ================================================================== ====== ====== =========== ======== ========= ============================================
1421
+
1422
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1278
1423
 
1279
1424
  Evaporative Cooler
1280
1425
  ~~~~~~~~~~~~~~~~~~
@@ -1290,24 +1435,25 @@ If an evaporative cooler is specified, additional information is entered in ``Co
1290
1435
 
1291
1436
  .. [#] If provided, HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1292
1437
 
1293
- Mini-Split
1294
- ~~~~~~~~~~
1438
+ Mini-Split Air Conditioner
1439
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~
1295
1440
 
1296
- If a mini-split is specified, additional information is entered in ``CoolingSystem``.
1441
+ If a mini-split air conditioner is specified, additional information is entered in ``CoolingSystem``.
1297
1442
 
1298
- =============================================== ======== ====== =========== ======== ========= ===============================================
1299
- Element Type Units Constraints Required Default Notes
1300
- =============================================== ======== ====== =========== ======== ========= ===============================================
1301
- ``DistributionSystem`` idref See [#]_ No ID of attached distribution system
1302
- ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
1303
- ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1304
- ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1305
- ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed
1306
- ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1307
- ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1308
- =============================================== ======== ====== =========== ======== ========= ===============================================
1443
+ ================================================================ ======== ====== =========== ======== ========= ===============================================
1444
+ Element Type Units Constraints Required Default Notes
1445
+ ================================================================ ======== ====== =========== ======== ========= ===============================================
1446
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system
1447
+ ``AnnualCoolingEfficiency[Units="SEER" or Units="SEER2"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency [#]_
1448
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1449
+ ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1450
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed
1451
+ ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1452
+ ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1453
+ ================================================================ ======== ====== =========== ======== ========= ===============================================
1309
1454
 
1310
1455
  .. [#] If provided, HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1456
+ .. [#] If SEER2 provided, converted to SEER using ANSI/RESNET/ICC 301-2022 Addendum C, where SEER = SEER2 / 0.95 if ducted and SEER = SEER2 if ductless.
1311
1457
  .. [#] FanPowerWattsPerCFM defaults to 0.07 W/cfm for ductless systems and 0.18 W/cfm for ducted systems.
1312
1458
  .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
1313
1459
  A non-zero airflow defect should typically only be applied for systems attached to ducts.
@@ -1316,6 +1462,10 @@ If a mini-split is specified, additional information is entered in ``CoolingSyst
1316
1462
  A non-zero charge defect should typically only be applied for systems that are pre-charged on site.
1317
1463
  See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
1318
1464
 
1465
+ .. note::
1466
+
1467
+ Mini-splits do not have a ``CompressorType`` input because they are assumed to be inverter driven (variable speed).
1468
+
1319
1469
  .. _hvac_cooling_chiller:
1320
1470
 
1321
1471
  Chiller
@@ -1382,7 +1532,7 @@ Each heat pump is entered as an ``/HPXML/Building/BuildingDetails/Systems/HVAC/H
1382
1532
  ``BackupType`` string See [#]_ No <none> Type of backup heating
1383
1533
  ================================= ======== ====== =========== ======== ========= ===============================================
1384
1534
 
1385
- .. [#] HeatPumpType choices are "air-to-air", "mini-split", "ground-to-air", "water-loop-to-air", or "packaged terminal heat pump".
1535
+ .. [#] HeatPumpType choices are "air-to-air", "mini-split", "ground-to-air", "water-loop-to-air", "packaged terminal heat pump", or "room air conditioner with reverse cycle".
1386
1536
  .. [#] HeatPumpFuel only choice is "electricity".
1387
1537
  .. [#] BackupType choices are "integrated" or "separate".
1388
1538
  Use "integrated" if the heat pump's distribution system and blower fan power applies to the backup heating (e.g., built-in electric strip heat or an integrated backup furnace, i.e., a dual-fuel heat pump).
@@ -1430,31 +1580,31 @@ Air-to-Air Heat Pump
1430
1580
 
1431
1581
  If an air-to-air heat pump is specified, additional information is entered in ``HeatPump``.
1432
1582
 
1433
- ==================================================================== ================= =========== ======================== ======== ========= =================================================
1434
- Element Type Units Constraints Required Default Notes
1435
- ==================================================================== ================= =========== ======================== ======== ========= =================================================
1436
- ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1437
- ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
1438
- ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating output capacity (excluding any backup heating)
1439
- ``HeatingCapacity17F`` double Btu/hr >= 0, <= HeatingCapacity No Heating output capacity at 17F, if available
1440
- ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1441
- ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1442
- ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1443
- ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
1444
- ``AnnualCoolingEfficiency[Units="SEER"]/Value`` or ``YearInstalled`` double or integer Btu/Wh or # > 0 or > 1600 Yes See [#]_ Rated cooling efficiency or Year installed
1445
- ``AnnualHeatingEfficiency[Units="HSPF"]/Value`` or ``YearInstalled`` double or integer Btu/Wh or # > 0 or > 1600 Yes See [#]_ Rated heating efficiency or Year installed
1446
- ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed
1447
- ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1448
- ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1449
- ==================================================================== ================= =========== ======================== ======== ========= =================================================
1583
+ ================================================================ ====== ======= ======================== ======== ========= =================================================
1584
+ Element Type Units Constraints Required Default Notes
1585
+ ================================================================ ====== ======= ======================== ======== ========= =================================================
1586
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1587
+ ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
1588
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating output capacity (excluding any backup heating)
1589
+ ``HeatingCapacity17F`` double Btu/hr >= 0, <= HeatingCapacity No Heating output capacity at 17F, if available
1590
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1591
+ ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1592
+ ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1593
+ ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
1594
+ ``AnnualCoolingEfficiency[Units="SEER" or Units="SEER2"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency [#]_
1595
+ ``AnnualHeatingEfficiency[Units="HSPF" or Units="HSPF2"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency [#]_
1596
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed
1597
+ ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1598
+ ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1599
+ ================================================================ ====== ======= ======================== ======== ========= =================================================
1450
1600
 
1451
1601
  .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1452
1602
  .. [#] CompressorType choices are "single stage", "two stage", or "variable speed".
1453
1603
  .. [#] If CompressorType not provided, defaults to "single stage" if SEER <= 15, else "two stage" if SEER <= 21, else "variable speed".
1454
- .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
1455
- .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
1456
- .. [#] If AnnualCoolingEfficiency[Units="SEER"]/Value not provided, defaults to SEER from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv`` based on YearInstalled.
1457
- .. [#] If AnnualHeatingEfficiency[Units="HSPF"]/Value not provided, defaults to HSPF from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/hvac_equipment_efficiency.csv`` based on YearInstalled.
1604
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1605
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1606
+ .. [#] If SEER2 provided, converted to SEER using ANSI/RESNET/ICC 301-2022 Addendum C, where SEER = SEER2 / 0.95 (assumed to be a split system).
1607
+ .. [#] If HSPF2 provided, converted to HSPF using ANSI/RESNET/ICC 301-2022 Addendum C, where HSPF = HSPF2 / 0.85 (assumed to be a split system).
1458
1608
  .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.5 W/cfm if HSPF <= 8.75, else 0.375 W/cfm.
1459
1609
  .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
1460
1610
  See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
@@ -1467,26 +1617,28 @@ Mini-Split Heat Pump
1467
1617
 
1468
1618
  If a mini-split heat pump is specified, additional information is entered in ``HeatPump``.
1469
1619
 
1470
- =============================================== ======== ====== ======================== ======== ========= ==============================================
1471
- Element Type Units Constraints Required Default Notes
1472
- =============================================== ======== ====== ======================== ======== ========= ==============================================
1473
- ``DistributionSystem`` idref See [#]_ No ID of attached distribution system, if present
1474
- ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating output capacity (excluding any backup heating)
1475
- ``HeatingCapacity17F`` double Btu/hr >= 0, <= HeatingCapacity No Heating output capacity at 17F, if available
1476
- ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1477
- ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1478
- ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1479
- ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
1480
- ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
1481
- ``AnnualHeatingEfficiency[Units="HSPF"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency
1482
- ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed
1483
- ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1484
- ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1485
- =============================================== ======== ====== ======================== ======== ========= ==============================================
1620
+ ================================================================ ======== ====== ======================== ======== ========= ==============================================
1621
+ Element Type Units Constraints Required Default Notes
1622
+ ================================================================ ======== ====== ======================== ======== ========= ==============================================
1623
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system, if present
1624
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating output capacity (excluding any backup heating)
1625
+ ``HeatingCapacity17F`` double Btu/hr >= 0, <= HeatingCapacity No Heating output capacity at 17F, if available
1626
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1627
+ ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1628
+ ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1629
+ ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
1630
+ ``AnnualCoolingEfficiency[Units="SEER" or Units="SEER2"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency [#]_
1631
+ ``AnnualHeatingEfficiency[Units="HSPF" or Units="HSPF2"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency [#]_
1632
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed
1633
+ ``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
1634
+ ``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed charges [#]_
1635
+ ================================================================ ======== ====== ======================== ======== ========= ==============================================
1486
1636
 
1487
1637
  .. [#] If provided, HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1488
- .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
1489
- .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
1638
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1639
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1640
+ .. [#] If SEER2 provided, converted to SEER using ANSI/RESNET/ICC 301-2022 Addendum C, where SEER = SEER2 / 0.95 if ducted and SEER = SEER2 if ductless.
1641
+ .. [#] If HSPF2 provided, converted to HSPF using ANSI/RESNET/ICC 301-2022 Addendum C, where HSPF = HSPF2 / 0.85 if ducted and HSPF = HSPF2 / 0.90 if ductless.
1490
1642
  .. [#] FanPowerWattsPerCFM defaults to 0.07 W/cfm for ductless systems and 0.18 W/cfm for ducted systems.
1491
1643
  .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
1492
1644
  A non-zero airflow defect should typically only be applied for systems attached to ducts.
@@ -1495,6 +1647,12 @@ If a mini-split heat pump is specified, additional information is entered in ``H
1495
1647
  A non-zero charge defect should typically only be applied for systems that are pre-charged on site.
1496
1648
  See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
1497
1649
 
1650
+ .. note::
1651
+
1652
+ Mini-splits do not have a ``CompressorType`` input because they are assumed to be inverter driven (variable speed).
1653
+
1654
+ .. _pthp:
1655
+
1498
1656
  Packaged Terminal Heat Pump
1499
1657
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1500
1658
 
@@ -1512,8 +1670,30 @@ If a packaged terminal heat pump is specified, additional information is entered
1512
1670
  ``AnnualHeatingEfficiency[Units="COP"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency
1513
1671
  =============================================================== ======== ====== =========== ======== ========= ==============================================
1514
1672
 
1515
- .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
1516
- .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
1673
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1674
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1675
+
1676
+ .. _room_ac_reverse_cycle:
1677
+
1678
+ Room Air Conditioner w/ Reverse Cycle
1679
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1680
+
1681
+ If a room air conditioner with reverse cycle is specified, additional information is entered in ``HeatPump``.
1682
+
1683
+ =============================================================== ======== ====== =========== ======== ========= ==============================================
1684
+ Element Type Units Constraints Required Default Notes
1685
+ =============================================================== ======== ====== =========== ======== ========= ==============================================
1686
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating output capacity (excluding any backup heating)
1687
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling output capacity
1688
+ ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1689
+ ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1690
+ ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
1691
+ ``AnnualCoolingEfficiency[Units="EER" or Units="CEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
1692
+ ``AnnualHeatingEfficiency[Units="COP"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency
1693
+ =============================================================== ======== ====== =========== ======== ========= ==============================================
1694
+
1695
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1696
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1517
1697
 
1518
1698
  Ground-to-Air Heat Pump
1519
1699
  ~~~~~~~~~~~~~~~~~~~~~~~
@@ -1542,8 +1722,8 @@ If a ground-to-air heat pump is specified, additional information is entered in
1542
1722
 
1543
1723
  .. [#] IsSharedSystem should be true if the SFA/MF building has multiple ground source heat pumps connected to a shared hydronic circulation loop.
1544
1724
  .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1545
- .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
1546
- .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
1725
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1726
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across all HVAC systems) must be less than or equal to 1.
1547
1727
  .. [#] NumberofUnitsServed only required if IsSharedSystem is true, in which case it must be > 1.
1548
1728
  .. [#] If PumpPowerWattsPerTon not provided, defaults to 30 W/ton per `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_ for a closed loop system.
1549
1729
  .. [#] Pump power is calculated using PumpPowerWattsPerTon and the cooling capacity in tons, unless the system only provides heating, in which case the heating capacity in tons is used instead.
@@ -1614,8 +1794,6 @@ If a heating and/or cooling season is defined, additional information is entered
1614
1794
  ``EndDayOfMonth`` integer 1 - 31 Yes End day
1615
1795
  =================== ======== ===== =========== ======== ======= ===========
1616
1796
 
1617
- Heating and cooling seasons, when combined, must span the entire year.
1618
-
1619
1797
  Thermostat setpoints are additionally entered using either simple inputs or hourly inputs.
1620
1798
  Alternatively, setpoints can be defined using :ref:`detailedschedules`.
1621
1799
 
@@ -1740,9 +1918,11 @@ Additional information is entered in each ``Ducts``.
1740
1918
  =============================================== ======= ============ ================ ======== ========= ======================================
1741
1919
  Element Type Units Constraints Required Default Notes
1742
1920
  =============================================== ======= ============ ================ ======== ========= ======================================
1921
+ ``SystemIdentifier`` id Yes Unique identifier
1743
1922
  ``DuctInsulationRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of duct insulation [#]_
1744
1923
  ``DuctLocation`` string See [#]_ No See [#]_ Duct location
1745
1924
  ``FractionDuctArea`` and/or ``DuctSurfaceArea`` double frac or ft2 0-1 [#]_ or >= 0 See [#]_ See [#]_ Duct fraction/surface area in location
1925
+ ``extension/DuctSurfaceAreaMultiplier`` double >= 0 No 1.0 Duct surface area multiplier
1746
1926
  =============================================== ======= ============ ================ ======== ========= ======================================
1747
1927
 
1748
1928
  .. [#] DuctInsulationRValue should not include air films (i.e., use 0 for an uninsulated duct).
@@ -1773,7 +1953,7 @@ To define a hydronic distribution system, additional information is entered in `
1773
1953
  ``HydronicDistributionType`` string See [#]_ Yes Type of hydronic distribution system
1774
1954
  ============================ ======= ======= =========== ======== ========= ====================================
1775
1955
 
1776
- .. [#] HydronicDistributionType choices are "radiator", "baseboard", "radiant floor", or "radiant ceiling".
1956
+ .. [#] HydronicDistributionType choices are "radiator", "baseboard", "radiant floor", "radiant ceiling", or "water loop".
1777
1957
 
1778
1958
  Distribution System Efficiency (DSE)
1779
1959
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1827,7 +2007,7 @@ If not entered, the simulation will not include mechanical ventilation.
1827
2007
  ``IsSharedSystem`` boolean See [#]_ No false Whether it serves multiple dwelling units
1828
2008
  ``FanType`` string See [#]_ Yes Type of ventilation system
1829
2009
  ``RatedFlowRate`` or ``TestedFlowRate`` or ``CalculatedFlowRate`` or ``DeliveredVentilation`` double cfm >= 0 No See [#]_ Flow rate [#]_
1830
- ``HoursInOperation`` double hrs/day 0 - 24 No See [#]_ Hours per day of operation
2010
+ ``HoursInOperation`` double hrs/day 0 - 24 See [#]_ See [#]_ Hours per day of operation
1831
2011
  ``FanPower`` double W >= 0 No See [#]_ Fan power
1832
2012
  ============================================================================================= ======== ======= =========== ======== ========= =========================================
1833
2013
 
@@ -1835,7 +2015,10 @@ If not entered, the simulation will not include mechanical ventilation.
1835
2015
  .. [#] FanType choices are "energy recovery ventilator", "heat recovery ventilator", "exhaust only", "supply only", "balanced", or "central fan integrated supply".
1836
2016
  .. [#] If flow rate not provided, defaults to the required mechanical ventilation rate per `ASHRAE 62.2-2019 <https://www.techstreet.com/ashrae/standards/ashrae-62-2-2019?product_id=2087691>`_, including adjustments for A) infiltration credit, B) balanced vs imbalanced systems, and C) adiabatic surfaces for SFA/MF buildings.
1837
2017
  .. [#] For a central fan integrated supply system, the flow rate should equal the amount of outdoor air provided to the distribution system.
2018
+ .. [#] HoursInOperation is optional unless the VentilationFan refers to the supplemental fan of a CFIS system, in which case it is not allowed.
1838
2019
  .. [#] If HoursInOperation not provided, defaults to 24 (i.e., running continuously) for all system types other than central fan integrated supply (CFIS), and 8.0 (i.e., running intermittently) for CFIS systems.
2020
+ For a CFIS system, the HoursInOperation and the flow rate are combined to form the hourly target ventilation rate (e.g., inputs of 90 cfm and 8 hrs/day produce an hourly target ventilation rate of 30 cfm).
2021
+ For a CFIS system with a supplemental fan, the supplemental fan's runtime is automatically calculated for each hour (based on the air handler runtime) to maintain the hourly target ventilation rate.
1839
2022
  .. [#] If FanPower not provided, defaults based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_:
1840
2023
 
1841
2024
  - "energy recovery ventilator", "heat recovery ventilator", or shared system: 1.0 W/cfm
@@ -1874,21 +2057,31 @@ If an energy recovery ventilator system is specified, additional information is
1874
2057
 
1875
2058
  **Central Fan Integrated Supply**
1876
2059
 
1877
- If a central fan integrated supply system is specified, additional information is entered in ``VentilationFan``.
2060
+ If a central fan integrated supply (CFIS) system is specified, additional information is entered in ``VentilationFan``.
1878
2061
 
1879
- ================================================ ====== ===== =========== ======== ======= ==================================
1880
- Element Type Units Constraints Required Default Notes
1881
- ================================================ ====== ===== =========== ======== ======= ==================================
1882
- ``AttachedToHVACDistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1883
- ``extension/VentilationOnlyModeAirflowFraction`` double 0 - 1 No 1.0 Blower airflow rate fraction during ventilation only mode [#]_
1884
- ================================================ ====== ===== =========== ======== ======= ==================================
2062
+ ================================================ ====== ===== =========== ======== =============== ==================================
2063
+ Element Type Units Constraints Required Default Notes
2064
+ ================================================ ====== ===== =========== ======== =============== ==================================
2065
+ ``CFISControls/AdditionalRuntimeOperatingMode`` string See [#]_ No air handler fan How additional ventilation is provided (beyond when the HVAC system is running)
2066
+ ``CFISControls/SupplementalFan`` idref See [#]_ See [#]_ The supplemental fan providing additional ventilation
2067
+ ``AttachedToHVACDistributionSystem`` idref See [#]_ Yes ID of attached distribution system
2068
+ ``extension/VentilationOnlyModeAirflowFraction`` double 0 - 1 No 1.0 Blower airflow rate fraction during ventilation only mode [#]_
2069
+ ================================================ ====== ===== =========== ======== =============== ==================================
1885
2070
 
2071
+ .. [#] AdditionalRuntimeOperatingMode choices are "air handler fan" or "supplemental fan".
2072
+ .. [#] SupplementalFan must reference another ``VentilationFan`` where UsedForWholeBuildingVentilation=true, IsSharedSystem=false, and FanType="exhaust only" or "supply only".
2073
+ .. [#] SupplementalFan only required if AdditionalRuntimeOperatingMode is "supplemental fan".
1886
2074
  .. [#] HVACDistribution type cannot be HydronicDistribution.
1887
2075
  .. [#] Blower airflow rate when operating in ventilation only mode (i.e., not heating or cooling mode), as a fraction of the maximum blower airflow rate.
1888
2076
  This value will depend on whether the blower fan can operate at reduced airflow rates during ventilation only operation.
1889
2077
  It is used to determine how much conditioned air is recirculated through ducts during ventilation only operation, resulting in additional duct losses.
1890
2078
  A value of zero will result in no conditioned air recirculation, and thus no additional duct losses.
1891
2079
 
2080
+ .. note::
2081
+
2082
+ CFIS systems are automated controllers that use the HVAC system's air handler fan to draw in outdoor air to meet an hourly ventilation target.
2083
+ CFIS systems are modeled as assuming they A) maximize the use of normal heating/cooling runtime operation to meet the hourly ventilation target, B) block the flow of outdoor air when the hourly ventilation target has been met, and C) provide additional runtime operation (via air handler fan or supplemental fan) to meet the remainder of the hourly ventilation target when space heating/cooling runtime alone is not sufficient.
2084
+
1892
2085
  **Shared System**
1893
2086
 
1894
2087
  If the specified system is a shared system (i.e., serving multiple dwelling units), additional information is entered in ``VentilationFan``.
@@ -2018,23 +2211,22 @@ Conventional Storage
2018
2211
 
2019
2212
  If a conventional storage water heater is specified, additional information is entered in ``WaterHeatingSystem``.
2020
2213
 
2021
- ================================================================ ================= ============= =============== ======== ======== ====================================================
2022
- Element Type Units Constraints Required Default Notes
2023
- ================================================================ ================= ============= =============== ======== ======== ====================================================
2024
- ``FuelType`` string See [#]_ Yes Fuel type
2025
- ``TankVolume`` double gal > 0 No See [#]_ Tank volume
2026
- ``HeatingCapacity`` double Btu/hr > 0 No See [#]_ Heating capacity
2027
- ``UniformEnergyFactor`` or ``EnergyFactor`` or ``YearInstalled`` double or integer frac or # < 1 or > 1600 Yes See [#]_ EnergyGuide label rated efficiency or Year installed
2028
- ``UsageBin`` or ``FirstHourRating`` string or double str or gal/hr See [#]_ or > 0 No See [#]_ EnergyGuide label usage bin/first hour rating
2029
- ``RecoveryEfficiency`` double frac 0 - 1 [#]_ No See [#]_ Recovery efficiency
2030
- ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional tank insulation wrap
2031
- ``extension/TankModelType`` string See [#]_ No mixed Tank model type
2032
- ================================================================ ================= ============= =============== ======== ======== ====================================================
2214
+ ============================================= ================= ============= =============== ======== ======== =============================================
2215
+ Element Type Units Constraints Required Default Notes
2216
+ ============================================= ================= ============= =============== ======== ======== =============================================
2217
+ ``FuelType`` string See [#]_ Yes Fuel type
2218
+ ``TankVolume`` double gal > 0 No See [#]_ Nominal tank volume
2219
+ ``HeatingCapacity`` double Btu/hr > 0 No See [#]_ Heating capacity
2220
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac < 1 Yes EnergyGuide label rated efficiency
2221
+ ``UsageBin`` or ``FirstHourRating`` string or double str or gal/hr See [#]_ or > 0 No See [#]_ EnergyGuide label usage bin/first hour rating
2222
+ ``RecoveryEfficiency`` double frac 0 - 1 [#]_ No See [#]_ Recovery efficiency
2223
+ ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional tank insulation wrap
2224
+ ``extension/TankModelType`` string See [#]_ No mixed Tank model type
2225
+ ============================================= ================= ============= =============== ======== ======== =============================================
2033
2226
 
2034
2227
  .. [#] FuelType choices are "natural gas", "fuel oil", "fuel oil 1", "fuel oil 2", "fuel oil 4", "fuel oil 5/6", "diesel", "propane", "kerosene", "coal", "coke", "bituminous coal", "anthracite coal", "electricity", "wood", or "wood pellets".
2035
2228
  .. [#] If TankVolume not provided, defaults based on Table 8 in the `2014 BAHSP <https://www.energy.gov/sites/prod/files/2014/03/f13/house_simulation_protocols_2014.pdf>`_.
2036
2229
  .. [#] If HeatingCapacity not provided, defaults based on Table 8 in the `2014 BAHSP <https://www.energy.gov/sites/prod/files/2014/03/f13/house_simulation_protocols_2014.pdf>`_.
2037
- .. [#] If UniformEnergyFactor and EnergyFactor not provided, defaults to EnergyFactor from the lookup table that can be found at ``HPXMLtoOpenStudio/resources/data/water_heater_efficiency.csv`` based on YearInstalled.
2038
2230
  .. [#] UsageBin choices are "very small", "low", "medium", or "high".
2039
2231
  .. [#] UsageBin/FirstHourRating are only used for water heaters that use UniformEnergyFactor.
2040
2232
  If neither UsageBin nor FirstHourRating provided, UsageBin defaults to "medium".
@@ -2073,8 +2265,8 @@ If a heat pump water heater is specified, additional information is entered in `
2073
2265
  Element Type Units Constraints Required Default Notes
2074
2266
  ============================================= ================ ============= =============== ======== ======== =============================================
2075
2267
  ``FuelType`` string See [#]_ Yes Fuel type
2076
- ``TankVolume`` double gal > 0 Yes Tank volume
2077
- ``UniformEnergyFactor`` or ``EnergyFactor`` double frac > 1 Yes EnergyGuide label rated efficiency
2268
+ ``TankVolume`` double gal > 0 Yes Nominal tank volume
2269
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac > 1, <= 5 Yes EnergyGuide label rated efficiency
2078
2270
  ``UsageBin`` or ``FirstHourRating`` string or double str or gal/hr See [#]_ or > 0 No See [#]_ EnergyGuide label usage bin/first hour rating
2079
2271
  ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional tank insulation wrap
2080
2272
  ``extension/OperatingMode`` string See [#]_ No standard Operating mode [#]_
@@ -2097,9 +2289,9 @@ If a combination boiler w/ storage tank (sometimes referred to as an indirect wa
2097
2289
  Element Type Units Constraints Required Default Notes
2098
2290
  ============================================= ======= ============ =========== ============ ======== ==================================================
2099
2291
  ``RelatedHVACSystem`` idref See [#]_ Yes ID of boiler
2100
- ``TankVolume`` double gal > 0 Yes Volume of the storage tank
2292
+ ``TankVolume`` double gal > 0 Yes Nominal volume of the storage tank
2101
2293
  ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional storage tank insulation wrap
2102
- ``StandbyLoss`` double F/hr > 0 No See [#]_ Storage tank standby losses
2294
+ ``StandbyLoss[Units="F/hr"]/Value`` double F/hr > 0 No See [#]_ Storage tank standby losses
2103
2295
  ============================================= ======= ============ =========== ============ ======== ==================================================
2104
2296
 
2105
2297
  .. [#] RelatedHVACSystem must reference a ``HeatingSystem`` (Boiler).
@@ -2131,6 +2323,10 @@ If the water heater uses a desuperheater, additional information is entered in `
2131
2323
 
2132
2324
  .. [#] RelatedHVACSystem must reference a ``HeatPump`` (air-to-air, mini-split, or ground-to-air) or ``CoolingSystem`` (central air conditioner or mini-split).
2133
2325
 
2326
+ .. warning::
2327
+
2328
+ A desuperheater is currently not allow if detailed water heater setpoint schedules are used.
2329
+
2134
2330
  HPXML Hot Water Distribution
2135
2331
  ****************************
2136
2332
 
@@ -2184,7 +2380,7 @@ If the in-unit distribution system is specified as recirculation, additional inf
2184
2380
  ================================= ======= ===== =========== ======== ======== =====================================
2185
2381
  ``ControlType`` string See [#]_ Yes Recirculation control type
2186
2382
  ``RecirculationPipingLoopLength`` double ft > 0 No See [#]_ Recirculation piping loop length [#]_
2187
- ``BranchPipingLoopLength`` double ft > 0 No 10 Branch piping loop length [#]_
2383
+ ``BranchPipingLength`` double ft > 0 No 10 Branch piping length [#]_
2188
2384
  ``PumpPower`` double W >= 0 No 50 [#]_ Recirculation pump power
2189
2385
  ================================= ======= ===== =========== ======== ======== =====================================
2190
2386
 
@@ -2196,7 +2392,7 @@ If the in-unit distribution system is specified as recirculation, additional inf
2196
2392
  | NCfl = number of conditioned floor levels number of conditioned floor levels in the residence including conditioned basements,
2197
2393
  | Bsmnt = presence (1.0) or absence (0.0) of an unconditioned basement in the residence.
2198
2394
  .. [#] RecirculationPipingLoopLength is the recirculation loop length including both supply and return sides, measured longitudinally from plans, assuming the hot water piping does not run diagonally, plus 20 feet of piping for each floor level greater than one plus 10 feet of piping for unconditioned basements.
2199
- .. [#] BranchPipingLoopLength is the length of the branch hot water piping from the recirculation loop to the farthest hot water fixture from the recirculation loop, measured longitudinally from plans, assuming the branch hot water piping does not run diagonally.
2395
+ .. [#] BranchPipingLength is the length of the branch hot water piping from the recirculation loop to the farthest hot water fixture from the recirculation loop, measured longitudinally from plans, assuming the branch hot water piping does not run diagonally.
2200
2396
  .. [#] PumpPower default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2201
2397
 
2202
2398
  Shared Recirculation
@@ -2242,12 +2438,14 @@ Each water fixture is entered as a ``/HPXML/Building/BuildingDetails/Systems/Wat
2242
2438
  Element Type Units Constraints Required Default Notes
2243
2439
  ==================== ======= ===== =========== ======== ======== ===============================================
2244
2440
  ``SystemIdentifier`` id Yes Unique identifier
2245
- ``WaterFixtureType`` string See [#]_ Yes Type of water fixture
2441
+ ``WaterFixtureType`` string See [#]_ Yes Bathroom faucet or shower
2246
2442
  ``LowFlow`` boolean Yes Whether the fixture is considered low-flow [#]_
2247
2443
  ==================== ======= ===== =========== ======== ======== ===============================================
2248
2444
 
2249
2445
  .. [#] WaterFixtureType choices are "shower head" or "faucet".
2446
+ If the shower stall has multiple shower heads that operate simultaneously, combine them as a single entry.
2250
2447
  .. [#] LowFlow should be true if the fixture's flow rate (gpm) is <= 2.0.
2448
+ Where a shower stall has multiple shower heads that operate simultaneously, the sum of their flows must be <= 2.0.
2251
2449
 
2252
2450
  Additional information can be entered in ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/``.
2253
2451
 
@@ -2376,7 +2574,7 @@ If not entered, the simulation will not include batteries.
2376
2574
  ``UsableCapacity[Units="kWh" or Units="Ah"]/Value`` double kWh or Ah >= 0, < NominalCapacity No See [#]_ Usable capacity
2377
2575
  ``RatedPowerOutput`` double W >= 0 No See [#]_ Power output under non-peak conditions
2378
2576
  ``NominalVoltage`` double V >= 0 No 50 Nominal voltage
2379
- ``extension/LifetimeModel`` string See [#]_ No None Lifetime model [#]_
2577
+ ``RoundTripEfficiency`` double frac 0 - 1 No 0.925 Round trip efficiency
2380
2578
  ==================================================== ======= ========= ======================= ======== ======== ============================================
2381
2579
 
2382
2580
  .. [#] Location choices are "living space", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "crawlspace - conditioned", "attic - vented", "attic - unvented", "garage", or "outside".
@@ -2384,14 +2582,14 @@ If not entered, the simulation will not include batteries.
2384
2582
  .. [#] If NominalCapacity not provided, defaults to UsableCapacity / 0.9 if UsableCapacity provided, else (RatedPowerOutput / 1000) / 0.5 if RatedPowerOutput provided, else 10 kWh.
2385
2583
  .. [#] If UsableCapacity not provided, defaults to 0.9 * NominalCapacity.
2386
2584
  .. [#] If RatedPowerOutput not provided, defaults to 0.5 * NominalCapacity * 1000.
2387
- .. [#] LifetimeModel choices are "None" or "KandlerSmith".
2388
- .. [#] If "None", the battery doesn't degrade over time. If "KandlerSmith", the battery degrades according to the `lifetime model developed by Kandler Smith <https://ieeexplore.ieee.org/abstract/document/7963578>`_.
2389
2585
 
2390
2586
  .. note::
2391
2587
 
2392
- A battery in a home with photovoltaics (PV) will be controlled using a simple control strategy. The battery will charge if PV production is greater than the building load and the battery is below its maximum capacity, while the battery will discharge if the building load is greater than PV production and the battery is above its minimum capacity.
2393
-
2394
- A battery in a home without PV is assumed to operate as backup and is not modeled.
2588
+ An unscheduled battery in a home with photovoltaics (PV) will be controlled using a simple control strategy designed to maximize on site consumption of energy. The battery will charge if PV production is greater than the building load and the battery is below its maximum capacity, while the battery will discharge if the building load is greater than PV production and the battery is above its minimum capacity.
2589
+
2590
+ A battery can alternatively be controlled using :ref:`detailedschedules`, where charging and discharging schedules are defined. Positive schedule values control timing and magnitude of charging storage. Negative schedule values control timing and magnitude of discharging storage. Simultaneous charging and discharging of the battery is not allowed. The round trip efficiency affects charging; the reported charging rate will be larger than the schedule value by an amount equal to the losses due to the round trip efficiency.
2591
+
2592
+ A battery in a home without PV or charging/discharging schedules is assumed to operate as backup and is not modeled.
2395
2593
 
2396
2594
  HPXML Generators
2397
2595
  ****************
@@ -2430,19 +2628,19 @@ HPXML Clothes Washer
2430
2628
  A single clothes washer can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/ClothesWasher``.
2431
2629
  If not entered, the simulation will not include a clothes washer.
2432
2630
 
2433
- ============================================================== ======= =========== =========== ======== ============ ==============================================
2434
- Element Type Units Constraints Required Default Notes
2435
- ============================================================== ======= =========== =========== ======== ============ ==============================================
2436
- ``SystemIdentifier`` id Yes Unique identifier
2437
- ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
2438
- ``Location`` string See [#]_ No living space Location
2439
- ``IntegratedModifiedEnergyFactor`` or ``ModifiedEnergyFactor`` double ft3/kWh/cyc > 0 No See [#]_ EnergyGuide label efficiency [#]_
2440
- ``AttachedToWaterHeatingSystem`` idref See [#]_ See [#]_ ID of attached water heater
2441
- ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
2442
- ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2443
- ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2444
- ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2445
- ============================================================== ======= =========== =========== ======== ============ ==============================================
2631
+ ====================================================================== ======= =========== =========== ======== ============ ==============================================
2632
+ Element Type Units Constraints Required Default Notes
2633
+ ====================================================================== ======= =========== =========== ======== ============ ==============================================
2634
+ ``SystemIdentifier`` id Yes Unique identifier
2635
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
2636
+ ``Location`` string See [#]_ No living space Location
2637
+ ``IntegratedModifiedEnergyFactor`` or ``ModifiedEnergyFactor`` double ft3/kWh/cyc > 0 No See [#]_ Efficiency [#]_
2638
+ ``AttachedToWaterHeatingSystem`` or ``AttachedToHotWaterDistribution`` idref See [#]_ See [#]_ ID of attached water heater or distribution system
2639
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
2640
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2641
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2642
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2643
+ ====================================================================== ======= =========== =========== ======== ============ ==============================================
2446
2644
 
2447
2645
  .. [#] For example, a clothes washer in a shared laundry room of a MF building.
2448
2646
  .. [#] Location choices are "living space", "basement - conditioned", "basement - unconditioned", "garage", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
@@ -2457,8 +2655,9 @@ If not entered, the simulation will not include a clothes washer.
2457
2655
  Capacity = 3.0.
2458
2656
  .. [#] If ModifiedEnergyFactor (MEF) provided instead of IntegratedModifiedEnergyFactor (IMEF), it will be converted using the `Interpretation on ANSI/RESNET 301-2014 Clothes Washer IMEF <https://www.resnet.us/wp-content/uploads/No.-301-2014-08-sECTION-4.2.2.5.2.8-Clothes-Washers-Eq-4.2-6.pdf>`_:
2459
2657
  IMEF = (MEF - 0.503) / 0.95.
2460
- .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``.
2461
- .. [#] AttachedToWaterHeatingSystem only required if IsSharedAppliance is true.
2658
+ IMEF may be found using the manufacturer’s data sheet, the `California Energy Commission Appliance Database <https://cacertappliances.energy.ca.gov/Pages/ApplianceSearch.aspx>`_, the `EPA ENERGY STAR website <https://www.energystar.gov/productfinder/>`_, or another reputable source.
2659
+ .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``; AttachedToHotWaterDistribution must reference a ``HotWaterDistribution``.
2660
+ .. [#] AttachedToWaterHeatingSystem (or AttachedToHotWaterDistribution) only required if IsSharedAppliance is true.
2462
2661
  .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided (and :ref:`detailedschedules` not used), default values from Figure 17 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.009, 0.007, 0.004, 0.004, 0.007, 0.011, 0.022, 0.049, 0.073, 0.086, 0.084, 0.075, 0.067, 0.060, 0.049, 0.052, 0.050, 0.049, 0.049, 0.049, 0.049, 0.047, 0.032, 0.017".
2463
2662
  .. [#] If MonthlyScheduleMultipliers not provided (and :ref:`detailedschedules` not used), default values from Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "1.011, 1.002, 1.022, 1.020, 1.022, 0.996, 0.999, 0.999, 0.996, 0.964, 0.959, 1.011".
2464
2663
 
@@ -2472,7 +2671,7 @@ If IntegratedModifiedEnergyFactor or ModifiedEnergyFactor is provided, a complet
2472
2671
  ``LabelGasRate`` double $/therm > 0 Yes EnergyGuide label natural gas rate
2473
2672
  ``LabelAnnualGasCost`` double $ > 0 Yes EnergyGuide label annual gas cost
2474
2673
  ``LabelUsage`` double cyc/wk > 0 Yes EnergyGuide label number of cycles
2475
- ``Capacity`` double ft3 > 0 Yes Clothes dryer volume
2674
+ ``Capacity`` double ft3 > 0 Yes Clothes washer volume
2476
2675
  ================================ ======= ======= =========== ============ ======= ====================================
2477
2676
 
2478
2677
  Clothes washer energy use and hot water use is calculated per the Energy Rating Rated Home in `ANSI/RESNET/ICC 301-2019 Addendum A <https://www.resnet.us/wp-content/uploads/ANSI_RESNET_ICC-301-2019-Addendum-A-2019_7.16.20-1.pdf>`_.
@@ -2490,7 +2689,7 @@ If not entered, the simulation will not include a clothes dryer.
2490
2689
  ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
2491
2690
  ``Location`` string See [#]_ No living space Location
2492
2691
  ``FuelType`` string See [#]_ Yes Fuel type
2493
- ``CombinedEnergyFactor`` or ``EnergyFactor`` double lb/kWh > 0 No See [#]_ EnergyGuide label efficiency [#]_
2692
+ ``CombinedEnergyFactor`` or ``EnergyFactor`` double lb/kWh > 0 No See [#]_ Efficiency [#]_
2494
2693
  ``Vented`` boolean No true Whether dryer is vented
2495
2694
  ``VentedFlowRate`` double cfm >= 0 No 100 [#]_ Exhaust flow rate during operation
2496
2695
  ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
@@ -2507,6 +2706,7 @@ If not entered, the simulation will not include a clothes dryer.
2507
2706
  CombinedEnergyFactor = 3.01.
2508
2707
  .. [#] If EnergyFactor (EF) provided instead of CombinedEnergyFactor (CEF), it will be converted using the following equation based on the `Interpretation on ANSI/RESNET/ICC 301-2014 Clothes Dryer CEF <https://www.resnet.us/wp-content/uploads/No.-301-2014-10-Section-4.2.2.5.2.8-Clothes-Dryer-CEF-Rating.pdf>`_:
2509
2708
  CEF = EF / 1.15.
2709
+ CEF may be found using the manufacturer’s data sheet, the `California Energy Commission Appliance Database <https://cacertappliances.energy.ca.gov/Pages/ApplianceSearch.aspx>`_, the `EPA ENERGY STAR website <https://www.energystar.gov/productfinder/>`_, or another reputable source.
2510
2710
  .. [#] VentedFlowRate default based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
2511
2711
  .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided (and :ref:`detailedschedules` not used), default values from Figure 18 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.010, 0.006, 0.004, 0.002, 0.004, 0.006, 0.016, 0.032, 0.048, 0.068, 0.078, 0.081, 0.074, 0.067, 0.057, 0.061, 0.055, 0.054, 0.051, 0.051, 0.052, 0.054, 0.044, 0.024".
2512
2712
  .. [#] If MonthlyScheduleMultipliers not provided (and :ref:`detailedschedules` not used), default values are used: "1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0".
@@ -2519,19 +2719,19 @@ HPXML Dishwasher
2519
2719
  A single dishwasher can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Dishwasher``.
2520
2720
  If not entered, the simulation will not include a dishwasher.
2521
2721
 
2522
- ============================================ ======= =========== =========== ======== ============ ==============================================
2523
- Element Type Units Constraints Required Default Notes
2524
- ============================================ ======= =========== =========== ======== ============ ==============================================
2525
- ``SystemIdentifier`` id Yes Unique identifier
2526
- ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
2527
- ``Location`` string See [#]_ No living space Location
2528
- ``RatedAnnualkWh`` or ``EnergyFactor`` double kWh/yr or # > 0 No See [#]_ EnergyGuide label consumption/efficiency [#]_
2529
- ``AttachedToWaterHeatingSystem`` idref See [#]_ See [#]_ ID of attached water heater
2530
- ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
2531
- ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2532
- ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2533
- ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2534
- ============================================ ======= =========== =========== ======== ============ ==============================================
2722
+ ====================================================================== ======= =========== =========== ======== ============ ==============================================
2723
+ Element Type Units Constraints Required Default Notes
2724
+ ====================================================================== ======= =========== =========== ======== ============ ==============================================
2725
+ ``SystemIdentifier`` id Yes Unique identifier
2726
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
2727
+ ``Location`` string See [#]_ No living space Location
2728
+ ``RatedAnnualkWh`` or ``EnergyFactor`` double kWh/yr or # > 0 No See [#]_ EnergyGuide label consumption/efficiency [#]_
2729
+ ``AttachedToWaterHeatingSystem`` or ``AttachedToHotWaterDistribution`` idref See [#]_ See [#]_ ID of attached water heater or distribution system
2730
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
2731
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2732
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2733
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2734
+ ====================================================================== ======= =========== =========== ======== ============ ==============================================
2535
2735
 
2536
2736
  .. [#] For example, a dishwasher in a shared mechanical room of a MF building.
2537
2737
  .. [#] Location choices are "living space", "basement - conditioned", "basement - unconditioned", "garage", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
@@ -2545,8 +2745,8 @@ If not entered, the simulation will not include a dishwasher.
2545
2745
  PlaceSettingCapacity = 12.
2546
2746
  .. [#] If EnergyFactor (EF) provided instead of RatedAnnualkWh, it will be converted using the following equation based on `ANSI/RESNET/ICC 301-2014 <https://codes.iccsafe.org/content/document/843>`_:
2547
2747
  RatedAnnualkWh = 215.0 / EF.
2548
- .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``.
2549
- .. [#] AttachedToWaterHeatingSystem only required if IsSharedAppliance is true.
2748
+ .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``; AttachedToHotWaterDistribution must reference a ``HotWaterDistribution``.
2749
+ .. [#] AttachedToWaterHeatingSystem (or AttachedToHotWaterDistribution) only required if IsSharedAppliance is true.
2550
2750
  .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided (and :ref:`detailedschedules` not used), default values from Figure 21 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.015, 0.007, 0.005, 0.003, 0.003, 0.010, 0.020, 0.031, 0.058, 0.065, 0.056, 0.048, 0.041, 0.046, 0.036, 0.038, 0.038, 0.049, 0.087, 0.111, 0.090, 0.067, 0.044, 0.031".
2551
2751
  .. [#] If MonthlyScheduleMultipliers not provided (and :ref:`detailedschedules` not used), default values from Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "1.097, 1.097, 0.991, 0.987, 0.991, 0.890, 0.896, 0.896, 0.890, 1.085, 1.085, 1.097".
2552
2752