urbanopt-cli 0.4.1 → 0.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (944) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -1
  3. data/CHANGELOG.md +59 -0
  4. data/CMakeLists.txt +17 -17
  5. data/FindOpenStudioSDK.cmake +12 -7
  6. data/Gemfile +8 -10
  7. data/LICENSE.md +11 -1
  8. data/README.md +1 -0
  9. data/Rakefile +16 -6
  10. data/example_files/Gemfile +25 -9
  11. data/example_files/example_project.json +35 -20
  12. data/example_files/example_project_combined.json +100 -5
  13. data/example_files/example_project_with_electric_network.json +2116 -0
  14. data/example_files/mappers/Baseline.rb +111 -51
  15. data/example_files/mappers/CreateBar.rb +19 -7
  16. data/example_files/mappers/EvCharging.rb +141 -0
  17. data/example_files/mappers/Floorspace.rb +29 -17
  18. data/example_files/mappers/HighEfficiency.rb +20 -8
  19. data/example_files/mappers/HighEfficiencyCreateBar.rb +19 -8
  20. data/example_files/mappers/HighEfficiencyFloorspace.rb +19 -8
  21. data/example_files/mappers/ThermalStorage.rb +16 -6
  22. data/example_files/mappers/base_workflow.osw +26 -1
  23. data/example_files/mappers/floorspace_workflow.osw +9 -0
  24. data/example_files/measures/BuildResidentialModel/measure.rb +249 -134
  25. data/example_files/reopt/base_assumptions.json +2 -2
  26. data/example_files/reopt/multiPV_assumptions.json +4 -3
  27. data/example_files/residential/clothes_dryer.tsv +7 -7
  28. data/example_files/residential/clothes_washer.tsv +2 -2
  29. data/example_files/residential/cooling_system.tsv +42 -22
  30. data/example_files/residential/dishwasher.tsv +1 -1
  31. data/example_files/residential/exhaust.tsv +3 -0
  32. data/example_files/residential/heat_pump.tsv +62 -40
  33. data/example_files/residential/water_heater.tsv +1 -1
  34. data/example_files/resources/hpxml-measures/.github/pull_request_template.md +14 -0
  35. data/example_files/resources/hpxml-measures/.github/workflows/config.yml +116 -0
  36. data/example_files/resources/hpxml-measures/.gitignore +1 -8
  37. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/measure.rb +1088 -1329
  38. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/measure.xml +1819 -1383
  39. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/constants.rb +0 -8
  40. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/geometry.rb +450 -362
  41. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules.rb +165 -112
  42. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_config.json +388 -0
  43. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_config.md +43 -0
  44. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_weekday_state_and_monthly_schedule_shift.csv +613 -0
  45. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_weekend_state_and_monthly_schedule_shift.csv +613 -0
  46. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-coal.osw +56 -82
  47. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-appliances-dehumidifier-ief.osw → base-appliances-dehumidifier-ief-portable.osw} +57 -83
  48. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-appliances-dehumidifier-50percent.osw → base-appliances-dehumidifier-ief-whole-home.osw} +59 -85
  49. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-dehumidifier.osw +56 -82
  50. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-gas.osw +56 -82
  51. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-modified.osw +56 -82
  52. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-none.osw +61 -87
  53. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-oil.osw +56 -82
  54. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-propane.osw +56 -82
  55. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-wood.osw +56 -82
  56. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-flat.osw +56 -82
  57. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-radiant-barrier.osw +56 -82
  58. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-unvented-insulated-roof.osw +56 -82
  59. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-vented.osw +56 -82
  60. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-bldgtype-multifamily-shared-boiler-only-baseboard.osw +341 -0
  61. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-bldgtype-multifamily-shared-boiler-only-fan-coil.osw +341 -0
  62. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-mechvent-shared-preconditioning.osw → base-bldgtype-multifamily-shared-mechvent-preconditioning.osw} +70 -95
  63. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-mechvent-shared.osw → base-bldgtype-multifamily-shared-mechvent.osw} +70 -95
  64. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-bldgtype-multifamily-shared-pv.osw +341 -0
  65. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-bldgtype-multifamily-shared-water-heater.osw +341 -0
  66. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-bldgtype-multifamily.osw +341 -0
  67. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-single-family-attached.osw → base-bldgtype-single-family-attached.osw} +59 -85
  68. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-combi-tankless-outside.osw +56 -82
  69. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-combi-tankless.osw +56 -82
  70. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-dwhr.osw +56 -82
  71. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect-outside.osw +56 -82
  72. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect-standbyloss.osw +56 -82
  73. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect-with-solar-fraction.osw +56 -82
  74. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect.osw +56 -82
  75. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-electric.osw +56 -82
  76. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-gas.osw +56 -82
  77. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-hpwh.osw +56 -82
  78. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-indirect.osw +56 -82
  79. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-low-flow-fixtures.osw +56 -82
  80. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-none.osw +57 -83
  81. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-demand.osw +56 -82
  82. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-manual.osw +56 -82
  83. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-nocontrol.osw +56 -82
  84. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-temperature.osw +56 -82
  85. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-timer.osw +56 -82
  86. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-direct-evacuated-tube.osw +56 -82
  87. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-direct-flat-plate.osw +56 -82
  88. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-direct-ics.osw +56 -82
  89. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-fraction.osw +56 -82
  90. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-indirect-flat-plate.osw +56 -82
  91. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-thermosyphon-flat-plate.osw +56 -82
  92. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-coal.osw +56 -82
  93. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-elec-uef.osw +338 -0
  94. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-gas-outside.osw +56 -82
  95. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-gas-uef.osw +338 -0
  96. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-gas.osw +56 -82
  97. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-outside.osw +56 -82
  98. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-uef.osw +338 -0
  99. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-with-solar-fraction.osw +56 -82
  100. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-with-solar.osw +56 -82
  101. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump.osw +56 -82
  102. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-oil.osw +56 -82
  103. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-wood.osw +56 -82
  104. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-electric-outside.osw +56 -83
  105. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-electric-uef.osw +337 -0
  106. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-electric.osw +56 -82
  107. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas-uef.osw +337 -0
  108. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas-with-solar-fraction.osw +56 -82
  109. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas-with-solar.osw +56 -82
  110. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas.osw +56 -82
  111. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-propane.osw +56 -82
  112. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-2stories-garage.osw +56 -82
  113. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-2stories.osw +56 -82
  114. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-1.osw +56 -82
  115. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-2.osw +56 -82
  116. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-4.osw +56 -82
  117. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-5.osw +56 -82
  118. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-garage.osw +56 -82
  119. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-ach-house-pressure.osw +56 -82
  120. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-cfm-house-pressure.osw +56 -82
  121. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-cfm50.osw +56 -82
  122. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-flue.osw +56 -82
  123. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-natural-ach.osw +57 -83
  124. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-overhangs.osw +57 -83
  125. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-windows-none.osw +56 -82
  126. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-ambient.osw +56 -82
  127. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-conditioned-basement-slab-insulation.osw +56 -82
  128. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-slab.osw +56 -82
  129. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unconditioned-basement-assembly-r.osw +55 -81
  130. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unconditioned-basement-wall-insulation.osw +55 -81
  131. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unconditioned-basement.osw +55 -81
  132. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unvented-crawlspace.osw +55 -81
  133. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-vented-crawlspace.osw +55 -81
  134. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-1-speed-cooling-only.osw +337 -0
  135. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-1-speed-heating-only.osw +337 -0
  136. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-1-speed.osw +56 -82
  137. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-2-speed.osw +56 -82
  138. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-var-speed.osw +56 -82
  139. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-coal-only.osw +56 -82
  140. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-elec-only.osw +56 -82
  141. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-gas-central-ac-1-speed.osw +56 -82
  142. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-gas-only.osw +56 -82
  143. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-oil-only.osw +56 -82
  144. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-propane-only.osw +56 -82
  145. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-wood-only.osw +56 -82
  146. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-only-1-speed.osw +56 -82
  147. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-only-2-speed.osw +56 -82
  148. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-only-var-speed.osw +56 -82
  149. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-plus-air-to-air-heat-pump-heating.osw +56 -82
  150. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed-electric.osw +55 -81
  151. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed.osw +55 -81
  152. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-2-speed.osw +55 -81
  153. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-var-speed.osw +55 -81
  154. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-mini-split-heat-pump-ducted.osw +56 -82
  155. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-ducts-leakage-percent.osw +56 -82
  156. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-elec-resistance-only.osw +56 -82
  157. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-evap-cooler-furnace-gas.osw +56 -82
  158. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-evap-cooler-only-ducted.osw +57 -83
  159. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-evap-cooler-only.osw +56 -82
  160. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-fireplace-wood-only.osw +56 -82
  161. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-fixed-heater-gas-only.osw +57 -83
  162. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-floor-furnace-propane-only.osw +56 -82
  163. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-coal-only.osw +337 -0
  164. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-elec-central-ac-1-speed.osw +56 -82
  165. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-elec-only.osw +56 -82
  166. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-central-ac-2-speed.osw +56 -82
  167. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-central-ac-var-speed.osw +56 -82
  168. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-only.osw +56 -82
  169. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-room-ac.osw +56 -82
  170. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-oil-only.osw +56 -82
  171. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-propane-only.osw +56 -82
  172. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-wood-only.osw +56 -82
  173. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-ground-to-air-heat-pump-cooling-only.osw +336 -0
  174. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-ground-to-air-heat-pump-heating-only.osw +336 -0
  175. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-ground-to-air-heat-pump.osw +56 -84
  176. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-airflow-defect-furnace-gas-central-ac-1-speed.osw +339 -0
  177. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-air-to-air-heat-pump-1-speed.osw +339 -0
  178. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-air-to-air-heat-pump-2-speed.osw +339 -0
  179. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-air-to-air-heat-pump-var-speed.osw +339 -0
  180. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-furnace-gas-central-ac-1-speed.osw +340 -0
  181. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-furnace-gas-central-ac-2-speed.osw +340 -0
  182. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-furnace-gas-central-ac-var-speed.osw +340 -0
  183. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-furnace-gas-only.osw +338 -0
  184. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-ground-to-air-heat-pump.osw +338 -0
  185. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-mini-split-air-conditioner-only-ducted.osw +338 -0
  186. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-all-mini-split-heat-pump-ducted.osw +339 -0
  187. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-charge-defect-furnace-gas-central-ac-1-speed.osw +338 -0
  188. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-install-quality-none-furnace-gas-central-ac-1-speed.osw +340 -0
  189. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-air-conditioner-only-ducted.osw +56 -82
  190. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-air-conditioner-only-ductless.osw +56 -82
  191. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ducted-cooling-only.osw +56 -82
  192. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ducted-heating-only.osw +56 -82
  193. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ducted.osw +57 -83
  194. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ductless.osw +57 -83
  195. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-none.osw +56 -82
  196. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-portable-heater-gas-only.osw +57 -83
  197. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-programmable-thermostat-detailed.osw +337 -0
  198. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-room-ac-only-33percent.osw +56 -82
  199. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-room-ac-only.osw +56 -82
  200. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-setpoints.osw +56 -82
  201. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-stove-oil-only.osw +56 -82
  202. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-stove-wood-pellets-only.osw +56 -82
  203. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-undersized.osw +56 -82
  204. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-wall-furnace-elec-only.osw +56 -82
  205. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-lighting-ceiling-fans.osw +57 -83
  206. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-lighting-detailed.osw +56 -82
  207. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-AMY-2012.osw +56 -82
  208. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-baltimore-md.osw +64 -90
  209. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-dallas-tx.osw +56 -82
  210. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-duluth-mn.osw +69 -95
  211. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-helena-mt.osw +337 -0
  212. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-honolulu-hi.osw +337 -0
  213. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-miami-fl.osw +56 -82
  214. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-phoenix-az.osw +337 -0
  215. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-portland-or.osw +337 -0
  216. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-balanced.osw +56 -82
  217. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-bath-kitchen-fans.osw +64 -92
  218. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-cfis-evap-cooler-only-ducted.osw +57 -83
  219. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-cfis.osw +56 -82
  220. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-erv-atre-asre.osw +56 -82
  221. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-erv.osw +56 -82
  222. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-exhaust-rated-flow-rate.osw +337 -0
  223. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-exhaust.osw +56 -82
  224. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-hrv-asre.osw +56 -82
  225. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-hrv.osw +56 -82
  226. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-supply.osw +56 -82
  227. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-whole-house-fan.osw +56 -82
  228. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-defaults.osw +57 -83
  229. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-loads-large-uncommon.osw +60 -86
  230. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-loads-large-uncommon2.osw +60 -86
  231. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-neighbor-shading.osw +56 -82
  232. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-shielding-of-home.osw +337 -0
  233. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-usage-multiplier.osw +52 -78
  234. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-pv.osw +52 -78
  235. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-vacancy-6-months.osw → base-schedules-stochastic-vacant.osw} +59 -85
  236. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-schedules-stochastic.osw +56 -82
  237. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-schedules-user-specified.osw +56 -82
  238. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-calendar-year-custom.osw +56 -82
  239. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-daylight-saving-custom.osw +56 -82
  240. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-daylight-saving-disabled.osw +56 -82
  241. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-runperiod-1-month.osw +56 -82
  242. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-timestep-10-mins.osw +56 -82
  243. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base.osw +56 -82
  244. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/build_residential_hpxml_test.rb +71 -57
  245. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-auto.osw +56 -82
  246. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-double-exterior.osw +341 -0
  247. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-double-loaded-interior.osw +341 -0
  248. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-eaves.osw +341 -0
  249. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-single-exterior-front.osw +341 -0
  250. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-double-loaded-interior.osw +341 -0
  251. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-left-bottom-double-loaded-interior.osw +341 -0
  252. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-left-bottom.osw +341 -0
  253. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-left-middle-double-loaded-interior.osw +341 -0
  254. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-left-middle.osw +341 -0
  255. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-left-top-double-loaded-interior.osw +341 -0
  256. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-left-top.osw +341 -0
  257. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-middle-bottom-double-loaded-interior.osw +341 -0
  258. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-middle-bottom.osw +341 -0
  259. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-middle-middle-double-loaded-interior.osw +341 -0
  260. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-middle-middle.osw +341 -0
  261. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-middle-top-double-loaded-interior.osw +341 -0
  262. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-middle-top.osw +341 -0
  263. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-right-bottom-double-loaded-interior.osw +341 -0
  264. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-right-bottom.osw +341 -0
  265. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-right-middle-double-loaded-interior.osw +341 -0
  266. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-right-middle.osw +341 -0
  267. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-right-top-double-loaded-interior.osw +341 -0
  268. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab-right-top.osw +341 -0
  269. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-slab.osw +341 -0
  270. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-double-loaded-interior.osw +341 -0
  271. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-left-bottom-double-loaded-interior.osw +341 -0
  272. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-left-bottom.osw +341 -0
  273. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-left-middle-double-loaded-interior.osw +341 -0
  274. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-left-middle.osw +341 -0
  275. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-left-top-double-loaded-interior.osw +341 -0
  276. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-left-top.osw +341 -0
  277. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-middle-bottom-double-loaded-interior.osw +341 -0
  278. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-middle-bottom.osw +341 -0
  279. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-middle-middle-double-loaded-interior.osw +341 -0
  280. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-middle-middle.osw +341 -0
  281. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-middle-top-double-loaded-interior.osw +341 -0
  282. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-middle-top.osw +341 -0
  283. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-right-bottom-double-loaded-interior.osw +341 -0
  284. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-right-bottom.osw +341 -0
  285. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-right-middle-double-loaded-interior.osw +341 -0
  286. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-right-middle.osw +341 -0
  287. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-right-top-double-loaded-interior.osw +341 -0
  288. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace-right-top.osw +341 -0
  289. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-unvented-crawlspace.osw +341 -0
  290. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-double-loaded-interior.osw +341 -0
  291. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-left-bottom-double-loaded-interior.osw +341 -0
  292. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-left-bottom.osw +341 -0
  293. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-left-middle-double-loaded-interior.osw +341 -0
  294. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-left-middle.osw +341 -0
  295. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-left-top-double-loaded-interior.osw +341 -0
  296. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-left-top.osw +341 -0
  297. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-middle-bottom-double-loaded-interior.osw +341 -0
  298. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-middle-bottom.osw +341 -0
  299. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-middle-middle-double-loaded-interior.osw +341 -0
  300. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-middle-middle.osw +341 -0
  301. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-middle-top-double-loaded-interior.osw +341 -0
  302. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-middle-top.osw +341 -0
  303. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-right-bottom-double-loaded-interior.osw +341 -0
  304. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-right-bottom.osw +341 -0
  305. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-right-middle-double-loaded-interior.osw +341 -0
  306. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-right-middle.osw +341 -0
  307. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-right-top-double-loaded-interior.osw +341 -0
  308. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace-right-top.osw +341 -0
  309. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-multifamily-vented-crawlspace.osw +341 -0
  310. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-atticroof-conditioned-eaves-gable.osw +339 -0
  311. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-atticroof-conditioned-eaves-hip.osw +339 -0
  312. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-atticroof-flat.osw +339 -0
  313. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-pv-shared.osw → extra-bldgtype-single-family-attached-double-exterior.osw} +62 -89
  314. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-double-loaded-interior.osw +339 -0
  315. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-dhw-shared-water-heater.osw → extra-bldgtype-single-family-attached-single-exterior-front.osw} +60 -86
  316. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-slab-middle.osw +339 -0
  317. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-slab-right.osw +339 -0
  318. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-slab.osw +339 -0
  319. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-unconditioned-basement-middle.osw +339 -0
  320. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-unconditioned-basement-right.osw +339 -0
  321. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-multifamily.osw → extra-bldgtype-single-family-attached-unconditioned-basement.osw} +64 -91
  322. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-unvented-crawlspace-middle.osw +339 -0
  323. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-unvented-crawlspace-right.osw +339 -0
  324. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-unvented-crawlspace.osw +339 -0
  325. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-vented-crawlspace-middle.osw +339 -0
  326. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-vented-crawlspace-right.osw +339 -0
  327. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-bldgtype-single-family-attached-vented-crawlspace.osw +339 -0
  328. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-dhw-solar-latitude.osw +56 -82
  329. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-enclosure-atticroof-conditioned-eaves-gable.osw +337 -0
  330. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-enclosure-atticroof-conditioned-eaves-hip.osw +337 -0
  331. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-enclosure-garage-atticroof-conditioned.osw +337 -0
  332. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-enclosure-garage-partially-protruded.osw +56 -82
  333. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-enclosure-windows-shading.osw +339 -0
  334. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-gas-hot-tub-heater-with-zero-kwh.osw +337 -0
  335. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-gas-pool-heater-with-zero-kwh.osw +337 -0
  336. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-pv-roofpitch.osw +56 -82
  337. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-schedules-random-seed.osw +338 -0
  338. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-heating-system-boiler-to-heat-pump.osw +336 -0
  339. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-heating-system-boiler-to-heating-system.osw +337 -0
  340. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-heating-system-fireplace-to-heat-pump.osw +337 -0
  341. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-second-heating-system-fireplace.osw → extra-second-heating-system-fireplace-to-heating-system.osw} +58 -84
  342. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-heating-system-portable-heater-to-heat-pump.osw +337 -0
  343. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-second-heating-system-portable-heater.osw → extra-second-heating-system-portable-heater-to-heating-system.osw} +56 -82
  344. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-refrigerator.osw +56 -82
  345. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-zero-clothes-washer-kwh.osw +337 -0
  346. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-zero-dishwasher-kwh.osw +337 -0
  347. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-zero-extra-refrigerator-kwh.osw +337 -0
  348. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-zero-freezer-kwh.osw +337 -0
  349. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-zero-refrigerator-kwh.osw +337 -0
  350. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/conditioned-attic-with-floor-insulation.osw +59 -85
  351. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/conditioned-attic-with-one-floor-above-grade.osw +337 -0
  352. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/conditioned-basement-with-ceiling-insulation.osw +56 -82
  353. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/cooling-system-and-heat-pump.osw +56 -82
  354. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/dhw-indirect-without-boiler.osw +56 -82
  355. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/ducts-location-and-areas-not-same-type.osw +56 -82
  356. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/foundation-wall-insulation-greater-than-height.osw +337 -0
  357. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/heating-system-and-heat-pump.osw +56 -82
  358. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multifamily-bottom-crawlspace-zero-foundation-height.osw +64 -89
  359. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multifamily-bottom-slab-non-zero-foundation-height.osw +64 -89
  360. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multifamily-no-building-orientation.osw +63 -88
  361. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-hvac-programmable-thermostat.osw → invalid_files/multipliers-without-fuel-loads.osw} +54 -80
  362. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multipliers-without-other-plug-loads.osw +337 -0
  363. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multipliers-without-tv-plug-loads.osw +337 -0
  364. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-dhw-uef.osw → invalid_files/multipliers-without-vehicle-plug-loads.osw} +58 -84
  365. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multipliers-without-well-pump-plug-loads.osw +337 -0
  366. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/non-electric-heat-pump-water-heater.osw +56 -82
  367. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/non-integer-ceiling-fan-quantity.osw +56 -82
  368. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/non-integer-geometry-num-bathrooms.osw +56 -82
  369. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/second-heating-system-but-no-primary-heating.osw +337 -0
  370. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/second-heating-system-serves-majority-heat.osw +56 -82
  371. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/second-heating-system-serves-total-heat-load.osw +337 -0
  372. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-attached-ambient.osw +58 -84
  373. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-attached-no-building-orientation.osw +58 -84
  374. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-detached-finished-basement-zero-foundation-height.osw +56 -82
  375. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-detached-slab-non-zero-foundation-height.osw +56 -82
  376. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-detached-with-shared-system.osw +337 -0
  377. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/slab-non-zero-foundation-height-above-grade.osw +56 -82
  378. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/unconditioned-basement-with-wall-and-ceiling-insulation.osw +56 -82
  379. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/unvented-attic-with-floor-and-roof-insulation.osw +56 -82
  380. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/unvented-crawlspace-with-wall-and-ceiling-insulation.osw +59 -85
  381. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/vented-attic-with-floor-and-roof-insulation.osw +58 -84
  382. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/vented-crawlspace-with-wall-and-ceiling-insulation.osw +56 -82
  383. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/zero-number-of-bedrooms.osw +337 -0
  384. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/schedules/vacant.csv +8761 -0
  385. data/example_files/resources/hpxml-measures/Changelog.md +249 -0
  386. data/example_files/resources/hpxml-measures/Gemfile +2 -5
  387. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/measure.rb +404 -1357
  388. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml +247 -171
  389. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/BaseElements.xsd +11 -101
  390. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/EPvalidator.xml +824 -301
  391. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/HPXMLDataTypes.xsd +18 -35
  392. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/HPXMLvalidator.xml +526 -0
  393. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/airflow.rb +135 -207
  394. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/constants.rb +14 -186
  395. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/constructions.rb +549 -93
  396. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/energyplus.rb +12 -15
  397. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/generator.rb +78 -0
  398. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/geometry.rb +413 -15
  399. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hotwater_appliances.rb +48 -37
  400. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml.rb +1627 -1227
  401. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_defaults.rb +1192 -434
  402. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hvac.rb +1555 -1616
  403. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hvac_sizing.rb +1436 -1479
  404. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/lighting.rb +3 -2
  405. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/location.rb +22 -10
  406. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/meta_measure.rb +85 -19
  407. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/minitest_helper.rb +4 -26
  408. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/misc_loads.rb +22 -46
  409. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/pv.rb +22 -21
  410. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/schedules.rb +51 -14
  411. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/simcontrols.rb +24 -7
  412. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/unit_conversions.rb +2 -0
  413. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/validator.rb +80 -19
  414. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/version.rb +9 -2
  415. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/waterheater.rb +106 -75
  416. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/xmlhelper.rb +109 -34
  417. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_airflow.rb +22 -36
  418. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_defaults.rb +1565 -768
  419. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_enclosure.rb +151 -0
  420. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_generator.rb +101 -0
  421. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hotwater_appliance.rb +9 -18
  422. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hvac.rb +316 -28
  423. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hvac_sizing.rb +53 -0
  424. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_lighting.rb +4 -2
  425. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_location.rb +13 -11
  426. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_miscloads.rb +4 -2
  427. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_pv.rb +5 -3
  428. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_simcontrols.rb +13 -11
  429. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_validation.rb +102 -62
  430. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_water_heater.rb +189 -35
  431. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/util.rb +26 -0
  432. data/example_files/resources/hpxml-measures/README.md +5 -5
  433. data/example_files/resources/hpxml-measures/Rakefile +2 -10
  434. data/example_files/resources/hpxml-measures/SimulationOutputReport/measure.rb +416 -299
  435. data/example_files/resources/hpxml-measures/SimulationOutputReport/measure.xml +364 -481
  436. data/example_files/resources/hpxml-measures/SimulationOutputReport/resources/constants.rb +1 -2
  437. data/example_files/resources/hpxml-measures/SimulationOutputReport/tests/output_report_test.rb +327 -320
  438. data/example_files/resources/hpxml-measures/docs/source/build_residential_hpxml.rst +3 -3
  439. data/example_files/resources/hpxml-measures/docs/source/conf.py +11 -5
  440. data/example_files/resources/hpxml-measures/docs/source/getting_started.rst +6 -6
  441. data/example_files/resources/hpxml-measures/docs/source/index.rst +2 -2
  442. data/example_files/resources/hpxml-measures/docs/source/intro.rst +7 -109
  443. data/example_files/resources/hpxml-measures/docs/source/nstatic/stylesheet.css +13 -1
  444. data/example_files/resources/hpxml-measures/docs/source/workflow_inputs.rst +2482 -0
  445. data/example_files/resources/hpxml-measures/docs/source/workflow_outputs.rst +282 -0
  446. data/example_files/resources/hpxml-measures/tasks.rb +2494 -1248
  447. data/example_files/resources/hpxml-measures/weather/USA_AZ_Phoenix-Sky.Harbor.Intl.AP.722780_TMY3-cache.csv +35 -0
  448. data/example_files/resources/hpxml-measures/weather/USA_AZ_Phoenix-Sky.Harbor.Intl.AP.722780_TMY3.epw +8768 -0
  449. data/example_files/resources/hpxml-measures/weather/USA_CO_Denver.Intl.AP.725650_TMY3-cache.csv +10 -10
  450. data/example_files/resources/hpxml-measures/weather/USA_HI_Honolulu.Intl.AP.911820_TMY3-cache.csv +35 -0
  451. data/example_files/resources/hpxml-measures/weather/USA_HI_Honolulu.Intl.AP.911820_TMY3.epw +8768 -0
  452. data/example_files/resources/hpxml-measures/weather/USA_MT_Helena.Rgnl.AP.727720_TMY3-cache.csv +35 -0
  453. data/example_files/resources/hpxml-measures/weather/USA_MT_Helena.Rgnl.AP.727720_TMY3.epw +8768 -0
  454. data/example_files/resources/hpxml-measures/weather/USA_OR_Portland.Intl.AP.726980_TMY3-cache.csv +35 -0
  455. data/example_files/resources/hpxml-measures/weather/USA_OR_Portland.Intl.AP.726980_TMY3.epw +8768 -0
  456. data/example_files/resources/hpxml-measures/workflow/run_simulation.rb +96 -21
  457. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-coal.xml +558 -559
  458. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-appliances-dehumidifier-ief.xml → base-appliances-dehumidifier-ief-portable.xml} +8 -7
  459. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-appliances-dehumidifier-50percent.xml → base-appliances-dehumidifier-ief-whole-home.xml} +10 -9
  460. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier-multiple.xml +535 -0
  461. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier.xml +525 -524
  462. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-gas.xml +558 -559
  463. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-modified.xml +564 -565
  464. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-none.xml +513 -513
  465. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-oil.xml +558 -559
  466. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-propane.xml +558 -559
  467. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-wood.xml +558 -559
  468. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-cathedral.xml +565 -566
  469. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-conditioned.xml +633 -634
  470. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-flat.xml +531 -532
  471. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-radiant-barrier.xml +517 -518
  472. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-unvented-insulated-roof.xml +562 -563
  473. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-vented.xml +565 -566
  474. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-enclosure-other-multifamily-buffer-space.xml → base-bldgtype-multifamily-adjacent-to-multifamily-buffer-space.xml} +34 -62
  475. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-adjacent-to-multiple.xml +554 -0
  476. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-enclosure-other-non-freezing-space.xml → base-bldgtype-multifamily-adjacent-to-non-freezing-space.xml} +34 -62
  477. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-enclosure-other-heated-space.xml → base-bldgtype-multifamily-adjacent-to-other-heated-space.xml} +34 -62
  478. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-enclosure-other-housing-unit.xml → base-bldgtype-multifamily-adjacent-to-other-housing-unit.xml} +34 -62
  479. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-baseboard.xml +425 -0
  480. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-fan-coil-ducted.xml +457 -0
  481. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-fan-coil.xml +427 -0
  482. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-water-loop-heat-pump.xml +479 -0
  483. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-cooling-tower-water-loop-heat-pump.xml +474 -0
  484. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-baseboard.xml +408 -0
  485. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil-ducted.xml +439 -0
  486. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil-eae.xml +406 -0
  487. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil.xml +409 -0
  488. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-water-loop-heat-pump.xml +457 -0
  489. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-baseboard.xml +407 -0
  490. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-fan-coil-ducted.xml +438 -0
  491. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-fan-coil.xml +408 -0
  492. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-water-loop-heat-pump.xml +456 -0
  493. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-cooling-tower-only-water-loop-heat-pump.xml +451 -0
  494. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-generator.xml +460 -0
  495. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-ground-loop-ground-to-air-heat-pump.xml +451 -0
  496. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-laundry-room.xml +466 -0
  497. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-mechvent-shared-multiple.xml → base-bldgtype-multifamily-shared-mechvent-multiple.xml} +43 -415
  498. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-mechvent-preconditioning.xml +489 -0
  499. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-mechvent.xml +473 -0
  500. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-pv.xml +465 -0
  501. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-water-heater-recirc.xml +458 -0
  502. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-water-heater.xml +451 -0
  503. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily.xml +448 -0
  504. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-single-family-attached.xml +619 -0
  505. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-combi-tankless-outside.xml +516 -519
  506. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-combi-tankless.xml +516 -519
  507. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-2-speed.xml +550 -551
  508. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-gshp.xml +7 -9
  509. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-hpwh.xml +563 -564
  510. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-tankless.xml +548 -549
  511. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-var-speed.xml +550 -551
  512. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater.xml +550 -551
  513. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-dwhr.xml +567 -568
  514. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-dse.xml +517 -520
  515. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-outside.xml +517 -520
  516. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-standbyloss.xml +518 -521
  517. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-with-solar-fraction.xml +525 -528
  518. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect.xml +517 -520
  519. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-electric.xml +567 -568
  520. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-gas.xml +568 -569
  521. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-hpwh.xml +566 -567
  522. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-indirect.xml +522 -525
  523. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-low-flow-fixtures.xml +562 -563
  524. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-multiple.xml +575 -578
  525. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-none.xml +497 -497
  526. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-demand.xml +565 -566
  527. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-manual.xml +565 -566
  528. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-nocontrol.xml +565 -566
  529. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-temperature.xml +565 -566
  530. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-timer.xml +565 -566
  531. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-evacuated-tube.xml +577 -578
  532. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-flat-plate.xml +577 -578
  533. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-ics.xml +577 -578
  534. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-fraction.xml +570 -571
  535. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-indirect-flat-plate.xml +577 -578
  536. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-thermosyphon-flat-plate.xml +577 -578
  537. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-coal.xml +563 -564
  538. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-elec-uef.xml +564 -0
  539. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas-outside.xml +563 -564
  540. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas-uef.xml +565 -0
  541. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas.xml +563 -564
  542. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-outside.xml +561 -562
  543. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-uef.xml +564 -0
  544. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-with-solar-fraction.xml +569 -570
  545. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-with-solar.xml +576 -577
  546. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump.xml +561 -562
  547. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-oil.xml +563 -564
  548. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-wood.xml +563 -564
  549. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric-outside.xml +561 -562
  550. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric-uef.xml +561 -0
  551. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric.xml +560 -561
  552. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-uef.xml +561 -0
  553. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-with-solar-fraction.xml +568 -569
  554. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-with-solar.xml +575 -576
  555. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas.xml +560 -561
  556. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-propane.xml +560 -561
  557. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-2stories-garage.xml +661 -664
  558. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-2stories.xml +575 -576
  559. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-1.xml +562 -563
  560. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-2.xml +562 -563
  561. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-4.xml +562 -563
  562. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-5.xml +562 -563
  563. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-garage.xml +636 -639
  564. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-ach-house-pressure.xml +562 -563
  565. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-cfm-house-pressure.xml +562 -563
  566. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-cfm50.xml +562 -563
  567. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-flue.xml +565 -566
  568. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-natural-ach.xml +561 -562
  569. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-overhangs.xml +582 -578
  570. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-rooftypes.xml +590 -591
  571. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-skylights-shading.xml +601 -0
  572. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-skylights.xml +590 -591
  573. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-level.xml +517 -0
  574. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-surfaces.xml +2474 -2493
  575. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-surfaces2.xml +2475 -0
  576. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-walltypes.xml +754 -755
  577. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-none.xml +504 -505
  578. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-enclosure-windows-interior-shading.xml → base-enclosure-windows-shading.xml} +23 -9
  579. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-ambient.xml +498 -497
  580. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-basement-garage.xml +644 -0
  581. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-complex.xml +724 -729
  582. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-conditioned-basement-slab-insulation.xml +562 -563
  583. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-conditioned-basement-wall-interior-insulation.xml +562 -563
  584. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-multiple.xml +685 -688
  585. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-slab.xml +516 -517
  586. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-above-grade.xml +609 -610
  587. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-assembly-r.xml +558 -559
  588. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-wall-insulation.xml +573 -574
  589. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement.xml +573 -574
  590. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unvented-crawlspace.xml +573 -574
  591. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-vented-crawlspace.xml +576 -577
  592. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-walkout-basement.xml +627 -628
  593. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed-autosize.xml → base-hvac-air-to-air-heat-pump-1-speed-cooling-only.xml} +8 -12
  594. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-air-to-air-heat-pump-1-speed-autosize-manual-s-oversize-allowances.xml → base-hvac-air-to-air-heat-pump-1-speed-heating-only.xml} +9 -9
  595. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-1-speed.xml +561 -562
  596. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-2-speed.xml +561 -562
  597. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-var-speed.xml +561 -562
  598. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-cooling-only.xml +553 -0
  599. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-air-to-air-heat-pump-1-speed-autosize.xml → base-hvac-autosize-air-to-air-heat-pump-1-speed-heating-only.xml} +5 -6
  600. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed-manual-s-oversize-allowances.xml +561 -0
  601. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-air-to-air-heat-pump-1-speed.xml +558 -0
  602. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-air-to-air-heat-pump-2-speed-autosize-manual-s-oversize-allowances.xml → base-hvac-autosize-air-to-air-heat-pump-2-speed-manual-s-oversize-allowances.xml} +4 -5
  603. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-air-to-air-heat-pump-2-speed-autosize.xml → base-hvac-autosize-air-to-air-heat-pump-2-speed.xml} +4 -5
  604. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-air-to-air-heat-pump-var-speed-autosize-manual-s-oversize-allowances.xml → base-hvac-autosize-air-to-air-heat-pump-var-speed-manual-s-oversize-allowances.xml} +4 -5
  605. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-air-to-air-heat-pump-var-speed-autosize.xml → base-hvac-autosize-air-to-air-heat-pump-var-speed.xml} +4 -5
  606. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-boiler-elec-only-autosize.xml → base-hvac-autosize-boiler-elec-only.xml} +2 -5
  607. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-boiler-gas-central-ac-1-speed-autosize.xml → base-hvac-autosize-boiler-gas-central-ac-1-speed.xml} +4 -6
  608. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-boiler-gas-only-autosize.xml → base-hvac-autosize-boiler-gas-only.xml} +2 -5
  609. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-central-ac-only-1-speed-autosize.xml → base-hvac-autosize-central-ac-only-1-speed.xml} +547 -548
  610. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-central-ac-only-2-speed-autosize.xml → base-hvac-autosize-central-ac-only-2-speed.xml} +4 -5
  611. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-central-ac-only-var-speed-autosize.xml → base-hvac-autosize-central-ac-only-var-speed.xml} +4 -5
  612. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-central-ac-plus-air-to-air-heat-pump-heating-autosize.xml → base-hvac-autosize-central-ac-plus-air-to-air-heat-pump-heating.xml} +570 -571
  613. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-dual-fuel-air-to-air-heat-pump-1-speed.xml +559 -0
  614. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-dual-fuel-mini-split-heat-pump-ducted-autosize.xml → base-hvac-autosize-dual-fuel-mini-split-heat-pump-ducted.xml} +557 -558
  615. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-elec-resistance-only-autosize.xml → base-hvac-autosize-elec-resistance-only.xml} +2 -5
  616. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-evap-cooler-furnace-gas-autosize.xml → base-hvac-autosize-evap-cooler-furnace-gas.xml} +4 -5
  617. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-floor-furnace-propane-only-autosize.xml → base-hvac-autosize-floor-furnace-propane-only.xml} +5 -6
  618. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-furnace-elec-only-autosize.xml → base-hvac-autosize-furnace-elec-only.xml} +4 -5
  619. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-furnace-gas-central-ac-2-speed-autosize.xml → base-hvac-autosize-furnace-gas-central-ac-2-speed.xml} +4 -5
  620. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-furnace-gas-central-ac-var-speed-autosize.xml → base-hvac-autosize-furnace-gas-central-ac-var-speed.xml} +4 -5
  621. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-furnace-gas-only-autosize.xml → base-hvac-autosize-furnace-gas-only.xml} +4 -6
  622. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-furnace-gas-room-ac-autosize.xml → base-hvac-autosize-furnace-gas-room-ac.xml} +4 -5
  623. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ground-to-air-heat-pump-cooling-only.xml +555 -0
  624. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-ground-to-air-heat-pump-heating-only.xml +560 -0
  625. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-ground-to-air-heat-pump-autosize-manual-s-oversize-allowances.xml → base-hvac-autosize-ground-to-air-heat-pump-manual-s-oversize-allowances.xml} +4 -6
  626. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-ground-to-air-heat-pump-autosize.xml → base-hvac-autosize-ground-to-air-heat-pump.xml} +4 -6
  627. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-air-conditioner-only-ducted.xml +547 -0
  628. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-cooling-only-autosize.xml → base-hvac-autosize-mini-split-heat-pump-ducted-cooling-only.xml} +551 -552
  629. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-heating-only-autosize.xml → base-hvac-autosize-mini-split-heat-pump-ducted-heating-only.xml} +556 -557
  630. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-autosize-mini-split-heat-pump-ducted-manual-s-oversize-allowances.xml +560 -0
  631. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-autosize.xml → base-hvac-autosize-mini-split-heat-pump-ducted.xml} +556 -557
  632. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-room-ac-only-autosize.xml → base-hvac-autosize-room-ac-only.xml} +2 -5
  633. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-stove-oil-only-autosize.xml → base-hvac-autosize-stove-oil-only.xml} +5 -6
  634. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-wall-furnace-elec-only-autosize.xml → base-hvac-autosize-wall-furnace-elec-only.xml} +5 -6
  635. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-autosize.xml → base-hvac-autosize.xml} +4 -5
  636. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-coal-only.xml +518 -521
  637. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-elec-only.xml +518 -521
  638. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-gas-central-ac-1-speed.xml +571 -573
  639. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-gas-only.xml +519 -522
  640. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-oil-only.xml +518 -521
  641. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-propane-only.xml +518 -521
  642. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-wood-only.xml +518 -521
  643. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-1-speed.xml +548 -549
  644. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-2-speed.xml +548 -549
  645. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-var-speed.xml +548 -549
  646. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-plus-air-to-air-heat-pump-heating.xml +575 -576
  647. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dse.xml +532 -535
  648. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed-electric.xml +562 -563
  649. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed.xml +562 -563
  650. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-2-speed.xml +562 -563
  651. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-var-speed.xml +562 -563
  652. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-mini-split-heat-pump-ducted.xml +561 -562
  653. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ducts-leakage-percent.xml +562 -563
  654. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-elec-resistance-only.xml +509 -512
  655. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-furnace-gas.xml +555 -555
  656. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-only-ducted.xml +536 -528
  657. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-only.xml +503 -505
  658. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-fireplace-wood-only.xml +6 -7
  659. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-fixed-heater-gas-only.xml +6 -57
  660. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-floor-furnace-propane-only.xml +6 -7
  661. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-coal-only.xml +549 -0
  662. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-elec-central-ac-1-speed.xml +562 -563
  663. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-elec-only.xml +548 -549
  664. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-central-ac-2-speed.xml +562 -563
  665. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-central-ac-var-speed.xml +562 -563
  666. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-only.xml +5 -7
  667. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-room-ac.xml +560 -561
  668. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-oil-only.xml +548 -549
  669. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-propane-only.xml +548 -549
  670. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-wood-only.xml +548 -549
  671. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-x3-dse.xml +576 -579
  672. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ground-to-air-heat-pump-cooling-only.xml +557 -0
  673. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ground-to-air-heat-pump-heating-only.xml +563 -0
  674. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ground-to-air-heat-pump.xml +7 -9
  675. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-hvac-flowrate.xml → base-hvac-install-quality-airflow-defect-furnace-gas-central-ac-1-speed.xml} +8 -9
  676. data/example_files/resources/hpxml-measures/workflow/sample_files/{invalid_files/heat-pump-mixed-fixed-and-autosize-capacities2.xml → base-hvac-install-quality-all-air-to-air-heat-pump-1-speed.xml} +13 -8
  677. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-all-air-to-air-heat-pump-2-speed.xml +567 -0
  678. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-all-air-to-air-heat-pump-var-speed.xml +567 -0
  679. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-all-furnace-gas-central-ac-1-speed.xml +572 -0
  680. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-all-furnace-gas-central-ac-2-speed.xml +572 -0
  681. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-all-furnace-gas-central-ac-var-speed.xml +572 -0
  682. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-all-furnace-gas-only.xml +553 -0
  683. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-all-ground-to-air-heat-pump.xml +566 -0
  684. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-mini-split-air-conditioner-only-ducted-autosize.xml → base-hvac-install-quality-all-mini-split-air-conditioner-only-ducted.xml} +10 -5
  685. data/example_files/resources/hpxml-measures/workflow/sample_files/{hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-autosize-manual-s-oversize-allowances.xml → base-hvac-install-quality-all-mini-split-heat-pump-ducted.xml} +13 -8
  686. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-blower-efficiency-furnace-gas-central-ac-1-speed.xml +569 -0
  687. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-misc-shelter-coefficient.xml → base-hvac-install-quality-charge-defect-furnace-gas-central-ac-1-speed.xml} +9 -10
  688. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-install-quality-none-furnace-gas-central-ac-1-speed.xml +570 -0
  689. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-air-conditioner-only-ducted.xml +547 -548
  690. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-air-conditioner-only-ductless.xml +508 -511
  691. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted-cooling-only.xml +554 -555
  692. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted-heating-only.xml +560 -561
  693. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted.xml +560 -561
  694. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ductless.xml +515 -518
  695. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-multiple.xml +21 -13
  696. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-none.xml +486 -489
  697. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-portable-heater-gas-only.xml +6 -57
  698. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-programmable-thermostat-detailed.xml +567 -0
  699. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-programmable-thermostat.xml +570 -571
  700. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only-33percent.xml +508 -511
  701. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only.xml +508 -511
  702. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-setpoints.xml +562 -563
  703. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-stove-oil-only.xml +6 -7
  704. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-stove-wood-pellets-only.xml +6 -7
  705. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-undersized-allow-increased-fixed-capacities.xml +565 -566
  706. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-undersized.xml +562 -563
  707. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-wall-furnace-elec-only.xml +6 -7
  708. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-ceiling-fans.xml +573 -574
  709. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-detailed.xml +585 -586
  710. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-none.xml +488 -489
  711. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-AMY-2012.xml +562 -563
  712. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-baltimore-md.xml +573 -563
  713. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-dallas-tx.xml +516 -517
  714. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-duluth-mn.xml +573 -563
  715. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-helena-mt.xml +563 -0
  716. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-honolulu-hi.xml +517 -0
  717. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-miami-fl.xml +516 -517
  718. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-phoenix-az.xml +517 -0
  719. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-portland-or.xml +577 -0
  720. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-balanced.xml +574 -575
  721. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-bath-kitchen-fans.xml +590 -591
  722. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-dse.xml +545 -548
  723. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-evap-cooler-only-ducted.xml +549 -541
  724. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis.xml +575 -576
  725. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-erv-atre-asre.xml +576 -577
  726. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-erv.xml +576 -577
  727. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-exhaust-rated-flow-rate.xml +574 -575
  728. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-exhaust.xml +574 -575
  729. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-hrv-asre.xml +575 -576
  730. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-hrv.xml +575 -576
  731. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-multiple.xml +796 -795
  732. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-supply.xml +574 -575
  733. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-whole-house-fan.xml +572 -573
  734. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-defaults.xml +478 -495
  735. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-generators.xml +579 -0
  736. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-large-uncommon.xml +758 -833
  737. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-large-uncommon2.xml +749 -820
  738. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-none.xml +550 -559
  739. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-neighbor-shading.xml +575 -576
  740. data/example_files/resources/hpxml-measures/workflow/sample_files/{invalid_files/invalid-calendar-year.xml → base-misc-shielding-of-home.xml} +7 -8
  741. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-usage-multiplier.xml +728 -725
  742. data/example_files/resources/hpxml-measures/workflow/sample_files/base-multiple-buildings.xml +1657 -0
  743. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv.xml +6 -7
  744. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-stochastic-vacant.xml +564 -0
  745. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-stochastic.xml +6 -7
  746. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-user-specified.xml +6 -7
  747. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-calendar-year-custom.xml +563 -564
  748. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-daylight-saving-custom.xml +569 -570
  749. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-daylight-saving-disabled.xml +565 -566
  750. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-runperiod-1-month.xml +566 -567
  751. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-timestep-10-mins.xml +562 -563
  752. data/example_files/resources/hpxml-measures/workflow/sample_files/base.xml +562 -563
  753. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/boiler-invalid-afue.xml +519 -0
  754. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/cfis-with-hydronic-distribution.xml +532 -535
  755. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/clothes-dryer-location.xml +562 -563
  756. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/clothes-washer-location.xml +562 -563
  757. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/cooking-range-location.xml +562 -563
  758. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dehumidifier-fraction-served.xml +535 -0
  759. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dehumidifier-setpoints.xml +535 -0
  760. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dhw-frac-load-served.xml +575 -578
  761. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-dhw-uef.xml → invalid_files/dhw-invalid-ef-tank.xml} +7 -8
  762. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dhw-invalid-uef-tank-heat-pump.xml +564 -0
  763. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dishwasher-location.xml +562 -563
  764. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duct-leakage-cfm25.xml +563 -0
  765. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duct-leakage-percent.xml +563 -0
  766. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duct-location-unconditioned-space.xml +562 -563
  767. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duct-location.xml +562 -563
  768. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duplicate-id.xml +562 -563
  769. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-attic-missing-roof.xml +546 -547
  770. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-basement-missing-exterior-foundation-wall.xml +543 -544
  771. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-basement-missing-slab.xml +546 -545
  772. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-floor-area-exceeds-cfa.xml +563 -0
  773. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-floor-area-exceeds-cfa2.xml +448 -0
  774. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-garage-missing-exterior-wall.xml +613 -616
  775. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-garage-missing-roof-ceiling.xml +626 -629
  776. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-garage-missing-slab.xml +610 -611
  777. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-living-missing-ceiling-roof.xml +550 -551
  778. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-living-missing-exterior-wall.xml +472 -473
  779. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-living-missing-floor-slab.xml +488 -534
  780. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/frac-sensible-fuel-load.xml +760 -0
  781. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/frac-sensible-plug-load.xml +759 -0
  782. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/frac-total-fuel-load.xml +761 -0
  783. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/frac-total-plug-load.xml +759 -0
  784. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/furnace-invalid-afue.xml +563 -0
  785. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/generator-number-of-bedrooms-served.xml +460 -0
  786. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/generator-output-greater-than-consumption.xml +579 -0
  787. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/heat-pump-mixed-fixed-and-autosize-capacities.xml +559 -560
  788. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-distribution-multiple-attached-cooling.xml +21 -13
  789. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-distribution-multiple-attached-heating.xml +21 -13
  790. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-distribution-return-duct-leakage-missing.xml +528 -534
  791. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-dse-multiple-attached-cooling.xml +546 -549
  792. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-dse-multiple-attached-heating.xml +546 -549
  793. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-frac-load-served.xml +21 -13
  794. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-inconsistent-fan-powers.xml +569 -0
  795. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-invalid-distribution-system-type.xml +570 -571
  796. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-shared-negative-seer-eq.xml +407 -0
  797. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-assembly-effective-rvalue.xml +563 -0
  798. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-datatype-boolean.xml +563 -0
  799. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-datatype-float.xml +563 -0
  800. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-datatype-integer.xml +563 -0
  801. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-daylight-saving.xml +569 -567
  802. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-distribution-cfa-served.xml +562 -563
  803. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-epw-filepath.xml +562 -563
  804. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-facility-type-equipment.xml +466 -0
  805. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-facility-type-surfaces.xml +644 -0
  806. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/{appliances-location-unconditioned-space.xml → invalid-foundation-wall-properties.xml} +39 -29
  807. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-id.xml +591 -0
  808. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-id2.xml +591 -0
  809. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-infiltration-volume.xml +563 -0
  810. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-input-parameters.xml +565 -0
  811. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-neighbor-shading-azimuth.xml +575 -576
  812. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-number-of-bedrooms-served.xml +465 -0
  813. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/{slab-zero-exposed-perimeter.xml → invalid-number-of-conditioned-floors.xml} +7 -8
  814. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-number-of-units-served.xml +451 -0
  815. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-relatedhvac-desuperheater.xml +550 -551
  816. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-relatedhvac-dhw-indirect.xml +517 -520
  817. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-runperiod.xml +564 -565
  818. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-schema-version.xml +563 -0
  819. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-shared-vent-in-unit-flowrate.xml +473 -0
  820. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-timestep.xml +562 -563
  821. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-window-height.xml +582 -578
  822. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/lighting-fractions.xml +562 -563
  823. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/missing-duct-location.xml +21 -13
  824. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/missing-elements.xml +560 -561
  825. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-appliance.xml +562 -563
  826. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-duct.xml +562 -563
  827. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-surface.xml +575 -566
  828. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-water-heater.xml +562 -563
  829. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multiple-buildings-without-building-id.xml +1657 -0
  830. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multiple-buildings-wrong-building-id.xml +1657 -0
  831. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multiple-shared-cooling-systems.xml +432 -0
  832. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multiple-shared-heating-systems.xml +434 -0
  833. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/net-area-negative-roof.xml +590 -591
  834. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/net-area-negative-wall.xml +562 -563
  835. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/num-bedrooms-exceeds-limit.xml +563 -0
  836. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/orphaned-hvac-distribution.xml +546 -547
  837. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/refrigerator-location.xml +562 -563
  838. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/refrigerators-multiple-primary.xml +568 -569
  839. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/refrigerators-no-primary.xml +568 -569
  840. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/repeated-relatedhvac-desuperheater.xml +563 -564
  841. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/repeated-relatedhvac-dhw-indirect.xml +526 -529
  842. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/solar-fraction-one.xml +571 -0
  843. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/solar-thermal-system-with-combi-tankless.xml +531 -534
  844. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/solar-thermal-system-with-desuperheater.xml +565 -566
  845. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/solar-thermal-system-with-dhw-indirect.xml +531 -534
  846. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-cfis.xml +575 -576
  847. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-door.xml +562 -563
  848. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-hvac-distribution.xml +562 -563
  849. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-shared-clothes-washer-water-heater.xml +465 -827
  850. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-shared-dishwasher-water-heater.xml +465 -827
  851. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-skylight.xml +590 -591
  852. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-solar-thermal-system.xml +577 -578
  853. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-window.xml +562 -563
  854. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/water-heater-location-other.xml +562 -563
  855. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/water-heater-location.xml +562 -563
  856. data/example_files/resources/hpxml-measures/workflow/template.osw +5 -1
  857. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L100AC.xml +6 -17
  858. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L100AL.xml +6 -17
  859. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L110AC.xml +6 -17
  860. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L110AL.xml +6 -17
  861. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L120AC.xml +6 -17
  862. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L120AL.xml +6 -17
  863. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L130AC.xml +6 -17
  864. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L130AL.xml +6 -17
  865. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L140AC.xml +6 -17
  866. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L140AL.xml +6 -17
  867. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L150AC.xml +6 -17
  868. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L150AL.xml +6 -17
  869. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L155AC.xml +6 -17
  870. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L155AL.xml +6 -17
  871. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L160AC.xml +6 -17
  872. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L160AL.xml +6 -17
  873. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L170AC.xml +6 -17
  874. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L170AL.xml +6 -17
  875. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L200AC.xml +6 -17
  876. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L200AL.xml +6 -17
  877. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L202AC.xml +6 -17
  878. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L202AL.xml +6 -17
  879. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L302XC.xml +6 -19
  880. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L304XC.xml +6 -19
  881. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L322XC.xml +6 -19
  882. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L324XC.xml +6 -19
  883. data/example_files/resources/hpxml-measures/workflow/tests/base_results/results.csv +294 -0
  884. data/example_files/resources/hpxml-measures/workflow/tests/base_results/results_ashrae_140.csv +27 -0
  885. data/example_files/resources/hpxml-measures/workflow/tests/base_results/results_hvac_sizing.csv +294 -0
  886. data/example_files/resources/hpxml-measures/workflow/tests/compare.rb +130 -0
  887. data/example_files/resources/hpxml-measures/workflow/tests/hpxml_translator_test.rb +522 -527
  888. data/example_files/{measures/BuildResidentialModel/resources → resources}/measure-info.json +0 -0
  889. data/example_files/{measures/BuildResidentialModel/resources → resources}/meta_measure.rb +53 -44
  890. data/example_files/validation_schema.yaml +149 -0
  891. data/example_files/visualization/input_visualization_feature.html +213 -56
  892. data/example_files/visualization/input_visualization_scenario.html +92 -30
  893. data/lib/uo_cli.rb +406 -128
  894. data/lib/uo_cli/version.rb +17 -7
  895. data/requirements.txt +2 -0
  896. data/scripts/setup-env-gitbash.sh +5 -5
  897. data/scripts/setup-env-unix.sh +4 -4
  898. data/scripts/setup-env.bat +14 -11
  899. data/scripts/setup-env.ps1 +13 -10
  900. data/uo_cli.gemspec +10 -8
  901. metadata +390 -130
  902. data/developer_nrel_key.rb +0 -31
  903. data/example_files/measures/ResidentialGeometryCreateMultifamily/measure.rb +0 -1005
  904. data/example_files/measures/ResidentialGeometryCreateMultifamily/measure.xml +0 -326
  905. data/example_files/measures/ResidentialGeometryCreateMultifamily/tests/create_residential_multifamily_geometry_test.rb +0 -477
  906. data/example_files/measures/ResidentialGeometryCreateSingleFamilyAttached/measure.rb +0 -1039
  907. data/example_files/measures/ResidentialGeometryCreateSingleFamilyAttached/measure.xml +0 -393
  908. data/example_files/measures/ResidentialGeometryCreateSingleFamilyAttached/tests/create_residential_single_family_attached_geometry_test.rb +0 -456
  909. data/example_files/measures/ResidentialGeometryCreateSingleFamilyDetached/measure.rb +0 -979
  910. data/example_files/measures/ResidentialGeometryCreateSingleFamilyDetached/measure.xml +0 -388
  911. data/example_files/measures/ResidentialGeometryCreateSingleFamilyDetached/tests/create_residential_single_family_detached_geometry_test.rb +0 -704
  912. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/location.rb +0 -24
  913. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_config.yml +0 -61
  914. data/example_files/resources/hpxml-measures/docs/source/hpxml_to_openstudio.rst +0 -1386
  915. data/example_files/resources/hpxml-measures/docs/source/simulation_output_report.rst +0 -252
  916. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-shared-laundry-room.xml +0 -828
  917. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-shared-water-heater-recirc.xml +0 -820
  918. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-shared-water-heater.xml +0 -813
  919. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-attached-multifamily.xml +0 -810
  920. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-common-surfaces.xml +0 -928
  921. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ideal-air.xml +0 -501
  922. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-multiple2.xml +0 -838
  923. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-baseboard.xml +0 -777
  924. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-fan-coil-ducted.xml +0 -808
  925. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-fan-coil.xml +0 -780
  926. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-water-loop-heat-pump.xml +0 -820
  927. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-cooling-tower-water-loop-heat-pump.xml +0 -815
  928. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-baseboard.xml +0 -760
  929. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-fan-coil-ducted.xml +0 -790
  930. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-fan-coil-eae.xml +0 -759
  931. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-fan-coil.xml +0 -762
  932. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-water-loop-heat-pump.xml +0 -796
  933. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-baseboard.xml +0 -759
  934. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-fan-coil-ducted.xml +0 -789
  935. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-fan-coil.xml +0 -761
  936. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-water-loop-heat-pump.xml +0 -796
  937. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-cooling-tower-only-water-loop-heat-pump.xml +0 -791
  938. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-ground-loop-ground-to-air-heat-pump.xml +0 -814
  939. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-shared-preconditioning.xml +0 -851
  940. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-shared.xml +0 -835
  941. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-shared.xml +0 -827
  942. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/coal-for-non-boiler-heating.xml +0 -514
  943. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-facility-type.xml +0 -828
  944. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-window-interior-shading.xml +0 -564
@@ -1,5 +1,5 @@
1
- BuildResidentialHPXML Measure
2
- =============================
1
+ BuildResidentialHPXML
2
+ =====================
3
3
 
4
4
  The BuildResidentialHPXML measure builds a residential HPXML file.
5
5
  The HPXML file that it produces is intended to be the input for the HPXMLtoOpenStudio measure.
@@ -27,7 +27,7 @@ The following arguments are used to populate fields of the HPXML file:
27
27
  - Daylight Saving Begin Month/Day
28
28
  - Daylight Saving End Month/Day
29
29
 
30
- Schedules
30
+ - Schedules
31
31
 
32
32
  - Type (Average, Stochastic, User-Specified)
33
33
  - Path
@@ -90,7 +90,10 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
90
90
  html_static_path = ['nstatic/']
91
91
 
92
92
  def setup(app):
93
- app.add_css_file("stylesheet.css")
93
+ try:
94
+ app.add_css_file("stylesheet.css")
95
+ except:
96
+ app.add_stylesheet("stylesheet.css")
94
97
 
95
98
  # Custom sidebar templates, must be a dictionary that maps document names
96
99
  # to template names.
@@ -114,15 +117,18 @@ htmlhelp_basename = 'OpenStudio-HPXMLdoc'
114
117
  latex_elements = {
115
118
  # The paper size ('letterpaper' or 'a4paper').
116
119
  #
117
- # 'papersize': 'letterpaper',
120
+ 'papersize': 'letterpaper',
118
121
 
119
122
  # The font size ('10pt', '11pt' or '12pt').
120
123
  #
121
- # 'pointsize': '10pt',
124
+ 'pointsize': '8pt',
122
125
 
123
126
  # Additional stuff for the LaTeX preamble.
124
127
  #
125
- # 'preamble': '',
128
+ 'preamble': '''
129
+ \usepackage[landscape]{geometry}
130
+ \geometry{left=49.5pt, right=49.5pt}
131
+ '''
126
132
 
127
133
  # Latex figure (float) alignment
128
134
  #
@@ -134,7 +140,7 @@ latex_elements = {
134
140
  # author, documentclass [howto, manual, or own class]).
135
141
  latex_documents = [
136
142
  (master_doc, 'OpenStudio-HPXML.tex', u'OpenStudio-HPXML Documentation',
137
- u'Scott Horowitz', 'manual'),
143
+ u'NREL', 'manual'),
138
144
  ]
139
145
 
140
146
 
@@ -6,15 +6,15 @@ Setup
6
6
 
7
7
  To get started:
8
8
 
9
- #. Download `OpenStudio 3.0.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.0.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
10
- #. Download the `latest release <https://github.com/NREL/OpenStudio-HPXML/releases>`_ for these OpenStudio measures.
9
+ #. Download `OpenStudio 3.2.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.2.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
10
+ #. Download the `latest release <https://github.com/NREL/OpenStudio-HPXML/releases>`_.
11
11
 
12
12
  Running
13
13
  -------
14
14
 
15
15
  To programatically run simulations, it's recommended to use the OpenStudio `Command Line Interface <http://nrel.github.io/OpenStudio-user-documentation/reference/command_line_interface/>`_.
16
16
  Two general approaches (basic and advanced) for running via the CLI are described below.
17
- The OpenStudio measures can also be run from user interfaces (e.g., the `OpenStudio Application <http://nrel.github.io/OpenStudio-user-documentation/reference/openstudio_application_interface/>`_ or `Parametric Analysis Tool <http://nrel.github.io/OpenStudio-user-documentation/reference/parametric_analysis_tool_2/>`_).
17
+ The OpenStudio measures can also be run from user interfaces (e.g., the OpenStudio Application or OpenStudio Parametric Analysis Tool (PAT)).
18
18
 
19
19
  .. note::
20
20
 
@@ -49,9 +49,9 @@ By default it will be found at the same location as the OSW file.
49
49
  Outputs
50
50
  ~~~~~~~
51
51
 
52
- In addition to the standard EnergyPlus outputs found in the run directory, a variety of high-level annual outputs are conveniently reported in the resulting ``run/results_annual.csv`` file.
52
+ In addition to the standard EnergyPlus outputs found in the run directory, a variety of high-level annual outputs are conveniently reported in the resulting ``run/results_annual.csv`` (or ``run/results_annual.json``) file.
53
53
 
54
54
  Timeseries outputs can also be requested using either the Basic or Advanced approaches.
55
- When requested, timeseries outputs will be found in the ``run/results_timeseries.csv`` file.
55
+ When requested, timeseries outputs will be found in the ``run/results_timeseries.csv`` (or ``run/results_timeseries.json``) file.
56
56
 
57
- See the :ref:`simreport` section for a description of all available outputs available.
57
+ See :ref:`workflow_outputs` for a description of all available outputs available.
@@ -12,9 +12,9 @@ OpenStudio-HPXML documentation
12
12
 
13
13
  intro
14
14
  getting_started
15
+ workflow_inputs
16
+ workflow_outputs
15
17
  build_residential_hpxml
16
- hpxml_to_openstudio
17
- simulation_output_report
18
18
 
19
19
  Indices and tables
20
20
  ==================
@@ -1,119 +1,15 @@
1
1
  Introduction
2
2
  ============
3
3
 
4
- The OpenStudio-HPXML repository consists of residential `OpenStudio measures <http://nrel.github.io/OpenStudio-user-documentation/getting_started/about_measures/>`_ that handle `HPXML files <https://hpxml.nrel.gov>`_.
4
+ The OpenStudio-HPXML repository consists of a simple residential EnergyPlus-based workflow build on top of `OpenStudio measures <http://nrel.github.io/OpenStudio-user-documentation/getting_started/about_measures/>`_.
5
+ The workflow operates using `HPXML building description files <https://hpxml.nrel.gov>`_.
5
6
 
6
- Measures
7
- --------
8
-
9
- This repository contains three OpenStudio measures:
7
+ The three OpenStudio measures used by the workflow are:
10
8
 
11
9
  #. ``BuildResidentialHPXML``: A measure that translates a set of building unit argument values to an HPXML file.
12
10
  #. ``HPXMLtoOpenStudio``: A measure that translates an HPXML file to an OpenStudio model.
13
11
  #. ``SimulationOutputReport``: A reporting measure that generates a variety of annual/timeseries outputs for a residential HPXML-based model.
14
12
 
15
- Modeling Capabilities
16
- ---------------------
17
- The OpenStudio-HPXML workflow can accommodate the following building features/technologies:
18
-
19
- - Enclosure
20
-
21
- - Attics
22
-
23
- - Vented
24
- - Unvented
25
- - Conditioned
26
- - Radiant Barriers
27
-
28
- - Foundations
29
-
30
- - Slab
31
- - Unconditioned Basement
32
- - Conditioned Basement
33
- - Vented Crawlspace
34
- - Unvented Crawlspace
35
- - Ambient
36
-
37
- - Garages
38
- - Windows & Overhangs
39
- - Skylights
40
- - Doors
41
-
42
- - HVAC
43
-
44
- - Heating Systems
45
-
46
- - Electric Resistance
47
- - Central/Wall/Floor Furnaces
48
- - Stoves, Portable/Fixed Heaters
49
- - Boilers
50
- - Fireplaces
51
-
52
- - Cooling Systems
53
-
54
- - Central/Room Air Conditioners
55
- - Evaporative Coolers
56
- - Mini Split Air Conditioners
57
- - Chillers
58
- - Cooling Towers
59
-
60
- - Heat Pumps
61
-
62
- - Air Source Heat Pumps
63
- - Mini Split Heat Pumps
64
- - Ground Source Heat Pumps
65
- - Dual-Fuel Heat Pumps
66
- - Water Loop Heat Pumps
67
-
68
- - Thermostat Setpoints
69
- - Ducts
70
-
71
- - Water Heating
72
-
73
- - Water Heaters
74
-
75
- - Storage Tank
76
- - Instantaneous Tankless
77
- - Heat Pump Water Heater
78
- - Indirect Water Heater (Combination Boiler)
79
- - Tankless Coil (Combination Boiler)
80
-
81
- - Solar Hot Water
82
- - Desuperheaters
83
- - Hot Water Distribution
84
-
85
- - Recirculation
86
-
87
- - Drain Water Heat Recovery
88
- - Hot Water Fixtures
89
-
90
- - Mechanical Ventilation
91
-
92
- - Exhaust Only
93
- - Supply Only
94
- - Balanced
95
- - Energy Recovery Ventilator
96
- - Heat Recovery Ventilator
97
- - Central Fan Integrated Supply
98
- - Shared Systems w/ Recirculation and/or Preconditioning
99
-
100
- - Kitchen/Bath Fans
101
- - Whole House Fan
102
- - Photovoltaics
103
- - Appliances
104
-
105
- - Clothes Washer
106
- - Clothes Dryer
107
- - Dishwasher
108
- - Refrigerator
109
- - Cooking Range/Oven
110
-
111
- - Dehumidifiers
112
- - Lighting
113
- - Ceiling Fans
114
- - Pool/Hot Tub
115
- - Plug/Fuel Loads
116
-
117
13
  Scope (Dwelling Units)
118
14
  ----------------------
119
15
 
@@ -148,9 +44,11 @@ End-to-end simulations typically run in 3-10 seconds, depending on complexity, c
148
44
 
149
45
  There are additional ways that software developers using this workflow can reduce runtime:
150
46
 
151
- - Run on Linux/Mac platform, which is significantly faster by taking advantage of the POSIX fork call.
152
- - Do not use the ``--hourly`` flag unless hourly output is required. If required, limit requests to hourly variables of interest.
47
+ - Run on Linux/Mac platform, which is significantly faster than Windows.
153
48
  - Run on computing environments with 1) fast CPUs, 2) sufficient memory, and 3) enough processors to allow all simulations to run in parallel.
49
+ - Limit requests for timeseries output (e.g., ``--hourly``, ``--daily``, ``--timestep`` arguments) and limit the number of output variables requested.
50
+ - Avoid using the ``--add-component-loads`` argument if heating/cooling component loads are not of interest.
51
+ - Use the ``--skip-validation`` argument if the HPXML input file has already been validated against the Schema & Schematron documents.
154
52
 
155
53
  License
156
54
  -------
@@ -45,4 +45,16 @@ div.math {
45
45
  max-width: 100%;
46
46
  overflow-x: auto;
47
47
  overflow-y: hidden;
48
- }
48
+ }
49
+
50
+ table th, table td {
51
+ /* Apply cell padding */
52
+ padding: 4px !important;
53
+ }
54
+
55
+ dl, dl dt, dl dd {
56
+ padding-top: 0 !important;
57
+ padding-bottom: 0 !important;
58
+ margin-bottom: 0 !important;
59
+ margin-top: 0 !important;
60
+ }
@@ -0,0 +1,2482 @@
1
+ .. _workflow_inputs:
2
+
3
+ Workflow Inputs
4
+ ===============
5
+
6
+ OpenStudio-HPXML requires a building description in an `HPXML file <https://hpxml.nrel.gov/>`_ format.
7
+ HPXML is an open data standard for collecting and transferring home energy data.
8
+ Using HPXML files reduces the complexity and effort for software developers to leverage the EnergyPlus simulation engine.
9
+
10
+ Using HPXML
11
+ -----------
12
+
13
+ HPXML is an flexible and extensible format, where nearly all elements in the schema are optional and custom elements can be included.
14
+ Because of this, a stricter set of requirements for the HPXML file have been developed for purposes of running EnergyPlus simulations.
15
+
16
+ HPXML files submitted to OpenStudio-HPXML should undergo a two step validation process:
17
+
18
+ 1. Validation against the HPXML Schema
19
+
20
+ The HPXML XSD Schema can be found at ``HPXMLtoOpenStudio/resources/HPXML.xsd``.
21
+ It should be used by the software developer to validate their HPXML file prior to running the simulation.
22
+ 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
+
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
+ 2. Validation using `Schematron <http://schematron.com/>`_
28
+
29
+ The Schematron document for the EnergyPlus use case can be found at ``HPXMLtoOpenStudio/resources/EPvalidator.xml``.
30
+ 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
+ As opposed to an XSD Schema, a Schematron document validates constraints and requirements based on conditionals and other logical statements.
32
+ 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.
35
+
36
+ .. important::
37
+
38
+ Usage of both validation approaches (XSD and Schematron) is recommended for developers actively working on creating HPXML files for EnergyPlus simulations:
39
+
40
+ - Validation against XSD for general correctness and usage of HPXML
41
+ - Validation against Schematron for understanding XML document requirements specific to running EnergyPlus
42
+
43
+ Input Defaults
44
+ **************
45
+
46
+ A large number of elements in the HPXML file are optional and can be defaulted.
47
+ Default values, equations, and logic are described throughout this documentation.
48
+
49
+ Defaults can also be seen in the ``in.xml`` file generated in the run directory, where additional fields are populated for inspection.
50
+
51
+ For example, suppose a HPXML file has a window defined as follows:
52
+
53
+ .. code-block:: XML
54
+
55
+ <Window>
56
+ <SystemIdentifier id='Window'/>
57
+ <Area>108.0</Area>
58
+ <Azimuth>0</Azimuth>
59
+ <UFactor>0.33</UFactor>
60
+ <SHGC>0.45</SHGC>
61
+ <AttachedToWall idref='Wall'/>
62
+ </Window>
63
+
64
+ In the ``in.xml`` file, the window would have additional elements like so:
65
+
66
+ .. code-block:: XML
67
+
68
+ <Window>
69
+ <SystemIdentifier id='Window'/>
70
+ <Area>108.0</Area>
71
+ <Azimuth>0</Azimuth>
72
+ <UFactor>0.33</UFactor>
73
+ <SHGC>0.45</SHGC>
74
+ <InteriorShading>
75
+ <SystemIdentifier id='WindowInteriorShading'/>
76
+ <SummerShadingCoefficient dataSource='software'>0.7</SummerShadingCoefficient>
77
+ <WinterShadingCoefficient dataSource='software'>0.85</WinterShadingCoefficient>
78
+ </InteriorShading>
79
+ <FractionOperable dataSource='software'>0.67</FractionOperable>
80
+ <AttachedToWall idref='Wall'/>
81
+ </Window>
82
+
83
+ .. note::
84
+
85
+ The OpenStudio-HPXML workflow generally treats missing elements differently than missing values.
86
+ For example, if there is a ``Window`` with no ``Overhangs`` element defined, the window will be interpreted as having no overhangs and modeled this way.
87
+ On the other hand, if there is a ``Window`` with no ``FractionOperable`` value defined, it is assumed that the operable property of the window is unknown and will be defaulted in the model according to :ref:`windowinputs`.
88
+
89
+ HPXML Software Info
90
+ -------------------
91
+
92
+ High-level simulation inputs are entered in ``/HPXML/SoftwareInfo``.
93
+
94
+ HPXML Simulation Control
95
+ ************************
96
+
97
+ EnergyPlus simulation controls are entered in ``/HPXML/SoftwareInfo/extension/SimulationControl``.
98
+
99
+ ================================== ======== ======= ============= ======== =========================== =====================================
100
+ Element Type Units Constraints Required Default Description
101
+ ================================== ======== ======= ============= ======== =========================== =====================================
102
+ ``Timestep`` integer minutes Divisor of 60 No 60 (1 hour) Timestep
103
+ ``BeginMonth`` integer 1 - 12 [#]_ No 1 (January) Run period start date
104
+ ``BeginDayOfMonth`` integer 1 - 31 No 1 Run period start date
105
+ ``EndMonth`` integer 1 - 12 No 12 (December) Run period end date
106
+ ``EndDayOfMonth`` integer 1 - 31 No Run period end date
107
+ ``CalendarYear`` integer > 1600 No 2007 (for TMY weather) [#]_ Calendar year (for start day of week)
108
+ ``DaylightSaving/Enabled`` boolean No true Daylight savings enabled?
109
+ ================================== ======== ======= ============= ======== =========================== =====================================
110
+
111
+ .. [#] BeginMonth/BeginDayOfMonth date must occur before EndMonth/EndDayOfMonth date (e.g., a run period from 10/1 to 3/31 is invalid).
112
+ .. [#] 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.
113
+
114
+ If daylight saving is enabled, additional information is specified in ``DaylightSaving``.
115
+
116
+ ====================================== ======== ===== ================= ======== ============================= ===========
117
+ Element Type Units Constraints Required Default Description
118
+ ====================================== ======== ===== ================= ======== ============================= ===========
119
+ ``BeginMonth`` and ``BeginDayOfMonth`` integer 1 - 12 and 1 - 31 No EPW else 3/12 (March 12) [#]_ Start date
120
+ ``EndMonth`` and ``EndDayOfMonth`` integer 1 - 12 and 1 - 31 No EPW else 11/5 (November 5) End date
121
+ ====================================== ======== ===== ================= ======== ============================= ===========
122
+
123
+ .. [#] Daylight savings dates will be defined according to the EPW weather file header; if not available, fallback default values listed above will be used.
124
+
125
+ HPXML HVAC Sizing Control
126
+ *************************
127
+
128
+ HVAC equipment sizing controls are entered in ``/HPXML/SoftwareInfo/extension/HVACSizingControl``.
129
+
130
+ ================================= ======== ===== =========== ======== ======= ============================================
131
+ Element Type Units Constraints Required Default Description
132
+ ================================= ======== ===== =========== ======== ======= ============================================
133
+ ``AllowIncreasedFixedCapacities`` boolean No false Logic for fixed capacity HVAC equipment [#]_
134
+ ``UseMaxLoadForHeatPumps`` boolean No true Logic for autosized heat pumps [#]_
135
+ ================================= ======== ===== =========== ======== ======= ============================================
136
+
137
+ .. [#] If AllowIncreasedFixedCapacities is true, the larger of user-specified fixed capacity and design load will be used (to reduce potential for unmet loads); otherwise user-specified fixed capacity is used.
138
+ .. [#] If UseMaxLoadForHeatPumps is true, autosized heat pumps are sized based on the maximum of heating/cooling design loads; otherwise sized per ACCA Manual J/S based on cooling design loads with some oversizing allowances for heating design loads.
139
+
140
+ HPXML Building Summary
141
+ ----------------------
142
+
143
+ High-level building summary information is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary``.
144
+
145
+ HPXML Site
146
+ **********
147
+
148
+ Building site information is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/Site``.
149
+
150
+ ================================ ======== ===== =========== ======== ======== ============================================================
151
+ Element Type Units Constraints Required Default Notes
152
+ ================================ ======== ===== =========== ======== ======== ============================================================
153
+ ``SiteType`` string See [#]_ No suburban Terrain type for infiltration model
154
+ ``ShieldingofHome`` string See [#]_ No normal Presence of nearby buildings, trees, obstructions for infiltration model
155
+ ``extension/Neighbors`` element >= 0 No <none> Presence of neighboring buildings for solar shading
156
+ ================================ ======== ===== =========== ======== ======== ============================================================
157
+
158
+ .. [#] SiteType choices are "rural", "suburban", or "urban".
159
+ .. [#] ShieldingofHome choices are "normal", "exposed", or "well-shielded".
160
+
161
+ For each neighboring building defined, additional information is entered in a ``extension/Neighbors/NeighborBuilding``.
162
+
163
+ ============ ======== ======= =========== ======== ======== =============================================
164
+ Element Type Units Constraints Required Default Notes
165
+ ============ ======== ======= =========== ======== ======== =============================================
166
+ ``Azimuth`` integer deg 0 - 359 Yes Direction of neighbors (clockwise from North)
167
+ ``Distance`` double ft > 0 Yes Distance of neighbor from the dwelling unit
168
+ ``Height`` double ft > 0 No See [#]_ Height of neighbor
169
+ ============ ======== ======= =========== ======== ======== =============================================
170
+
171
+ .. [#] If Height not provided, assumed to be same height as the dwelling unit.
172
+
173
+ HPXML Building Occupancy
174
+ ************************
175
+
176
+ Building occupancy is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/BuildingOccupancy``.
177
+
178
+ ===================== ======== ===== =========== ======== ==================== ========================
179
+ Element Type Units Constraints Required Default Notes
180
+ ===================== ======== ===== =========== ======== ==================== ========================
181
+ ``NumberofResidents`` integer >= 0 No <number of bedrooms> Number of occupants [#]_
182
+ ===================== ======== ===== =========== ======== ==================== ========================
183
+
184
+ .. [#] NumberofResidents is only used for occupant heat gain.
185
+ Most occupancy assumptions (e.g., usage of plug loads, appliances, hot water, etc.) are driven by the number of bedrooms, not number of occupants.
186
+
187
+ HPXML Building Construction
188
+ ***************************
189
+
190
+ Building construction is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/BuildingConstruction``.
191
+
192
+ ========================================================= ======== ========= ================================= ======== ======== =======================================================================
193
+ Element Type Units Constraints Required Default Notes
194
+ ========================================================= ======== ========= ================================= ======== ======== =======================================================================
195
+ ``ResidentialFacilityType`` string See [#]_ Yes Type of dwelling unit
196
+ ``NumberofConditionedFloors`` double > 0 Yes Number of conditioned floors (including a basement)
197
+ ``NumberofConditionedFloorsAboveGrade`` double > 0, <= NumberofConditionedFloors Yes Number of conditioned floors above grade (including a walkout basement)
198
+ ``NumberofBedrooms`` integer > 0 [#]_ Yes Number of bedrooms [#]_
199
+ ``NumberofBathrooms`` integer > 0 No See [#]_ Number of bathrooms
200
+ ``ConditionedFloorArea`` double ft2 > 0 Yes Floor area within conditioned space boundary
201
+ ``ConditionedBuildingVolume`` or ``AverageCeilingHeight`` double ft3 or ft > 0 No See [#]_ Volume/ceiling height within conditioned space boundary
202
+ ``extension/HasFlueOrChimney`` boolean No See [#]_ Presence of flue or chimney for infiltration model
203
+ ========================================================= ======== ========= ================================= ======== ======== =======================================================================
204
+
205
+ .. [#] ResidentialFacilityType choices are "single-family detached", "single-family attached", "apartment unit", or "manufactured home".
206
+ .. [#] NumberofBedrooms must also be <= (ConditionedFloorArea-120)/70.
207
+ .. [#] NumberofBedrooms is currently used to determine usage of plug loads, appliances, hot water, etc.
208
+ .. [#] If NumberofBathrooms not provided, calculated as NumberofBedrooms/2 + 0.5 based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
209
+ .. [#] If neither ConditionedBuildingVolume nor AverageCeilingHeight provided, AverageCeilingHeight defaults to 8.0.
210
+ If needed, additional defaulting is performed using the following relationship: ConditionedBuildingVolume = ConditionedFloorArea * AverageCeilingHeight.
211
+ .. [#] If HasFlueOrChimney not provided, assumed to be true if any of the following conditions are met:
212
+
213
+ - heating system is non-electric Furnace, Boiler, WallFurnace, FloorFurnace, Stove, PortableHeater, or FixedHeater and AFUE/Percent is less than 0.89,
214
+ - heating system is non-electric Fireplace, or
215
+ - water heater is non-electric with energy factor (or equivalent calculated from uniform energy factor) less than 0.63.
216
+
217
+ HPXML Weather Station
218
+ ---------------------
219
+
220
+ Weather information is entered in ``/HPXML/Building/BuildingDetails/ClimateandRiskZones/WeatherStation``.
221
+
222
+ ========================= ====== ======= =========== ======== ======= ==============================================
223
+ Element Type Units Constraints Required Default Notes
224
+ ========================= ====== ======= =========== ======== ======= ==============================================
225
+ ``SystemIdentifier`` id Yes Unique identifier
226
+ ``Name`` string Yes Name of weather station
227
+ ``extension/EPWFilePath`` string Yes Path to the EnergyPlus weather file (EPW) [#]_
228
+ ========================= ====== ======= =========== ======== ======= ==============================================
229
+
230
+ .. [#] A full set of U.S. TMY3 weather files can be `downloaded here <https://data.nrel.gov/system/files/128/tmy3s-cache-csv.zip>`_.
231
+
232
+ HPXML Enclosure
233
+ ---------------
234
+
235
+ The dwelling unit's enclosure is entered in ``/HPXML/Building/BuildingDetails/Enclosure``.
236
+
237
+ All surfaces that bound different space types of the dwelling unit (i.e., not just thermal boundary surfaces) must be specified in the HPXML file.
238
+ For example, an attached garage would generally be defined by walls adjacent to conditioned space, walls adjacent to outdoors, a slab, and a roof or ceiling.
239
+ For software tools that do not collect sufficient inputs for every required surface, the software developers will need to make assumptions about these surfaces or collect additional input.
240
+
241
+ Interior partition surfaces (e.g., walls between rooms inside conditioned space, or the floor between two conditioned stories) can be excluded.
242
+
243
+ For single-family attached (SFA) or multifamily (MF) buildings, surfaces between unconditioned space and the neighboring unit's same unconditioned space should set ``InteriorAdjacentTo`` and ``ExteriorAdjacentTo`` to the same value.
244
+ For example, a foundation wall between the unit's vented crawlspace and the neighboring unit's vented crawlspace would use ``InteriorAdjacentTo="crawlspace - vented"`` and ``ExteriorAdjacentTo="crawlspace - vented"``.
245
+
246
+ .. warning::
247
+
248
+ It is the software tool's responsibility to provide the appropriate building surfaces.
249
+ While some error-checking is in place, it is not possible to know whether some surfaces are incorrectly missing.
250
+
251
+ Also note that wall and roof surfaces do not require an azimuth to be specified.
252
+ Rather, only the windows/skylights themselves require an azimuth.
253
+ Thus, software tools can choose to use a single wall (or roof) surface to represent multiple wall (or roof) surfaces for the entire building if all their other properties (construction type, interior/exterior adjacency, etc.) are identical.
254
+
255
+ HPXML Air Infiltration
256
+ **********************
257
+
258
+ Building air leakage is entered in ``/HPXML/Building/BuildingDetails/Enclosure/AirInfiltration/AirInfiltrationMeasurement``.
259
+
260
+ ==================================== ====== ===== ================================= ========= ========================= ===============================================
261
+ Element Type Units Constraints Required Default Notes
262
+ ==================================== ====== ===== ================================= ========= ========================= ===============================================
263
+ ``SystemIdentifier`` id Yes Unique identifier
264
+ ``BuildingAirLeakage/UnitofMeasure`` string See [#]_ Yes Units for air leakage
265
+ ``HousePressure`` double Pa > 0 See [#]_ House pressure with respect to outside [#]_
266
+ ``BuildingAirLeakage/AirLeakage`` double > 0 Yes Value for air leakage
267
+ ``InfiltrationVolume`` double ft3 > 0, >= ConditionedBuildingVolume No ConditionedBuildingVolume Volume associated with infiltration measurement
268
+ ==================================== ====== ===== ================================= ========= ========================= ===============================================
269
+
270
+ .. [#] UnitofMeasure choices are "ACH" (air changes per hour at user-specified pressure), "CFM" (cubic feet per minute at user-specified pressure), or "ACHnatural" (natural air changes per hour).
271
+ .. [#] HousePressure only required if BuildingAirLeakage/UnitofMeasure is not "ACHnatural".
272
+ .. [#] HousePressure typical value is 50 Pa.
273
+
274
+ HPXML Attics
275
+ ************
276
+
277
+ If the dwelling unit has a vented attic, attic ventilation information can be optionally entered in ``/HPXML/Building/BuildingDetails/Enclosure/Attics/Attic[AtticType/Attic[Vented="true"]]/VentilationRate``.
278
+
279
+ ================= ====== ===== =========== ======== ========== ==========================
280
+ Element Type Units Constraints Required Default Notes
281
+ ================= ====== ===== =========== ======== ========== ==========================
282
+ ``UnitofMeasure`` string See [#]_ No SLA Units for ventilation rate
283
+ ``Value`` double > 0 No 1/300 [#]_ Value for ventilation rate
284
+ ================= ====== ===== =========== ======== ========== ==========================
285
+
286
+ .. [#] UnitofMeasure choices are "SLA" (specific leakage area) or "ACHnatural" (natural air changes per hour).
287
+ .. [#] Value default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
288
+
289
+ HPXML Foundations
290
+ *****************
291
+
292
+ If the dwelling unit has a vented crawlspace, crawlspace ventilation information can be optionally entered in ``/HPXML/Building/BuildingDetails/Enclosure/Foundations/Foundation[FoundationType/Crawlspace[Vented="true"]]/VentilationRate``.
293
+
294
+ ================= ====== ===== =========== ======== ========== ==========================
295
+ Element Type Units Constraints Required Default Notes
296
+ ================= ====== ===== =========== ======== ========== ==========================
297
+ ``UnitofMeasure`` string See [#]_ No SLA Units for ventilation rate
298
+ ``Value`` double > 0 No 1/150 [#]_ Value for ventilation rate
299
+ ================= ====== ===== =========== ======== ========== ==========================
300
+
301
+ .. [#] UnitofMeasure only choice is "SLA" (specific leakage area).
302
+ .. [#] Value default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
303
+
304
+ HPXML Roofs
305
+ ***********
306
+
307
+ Each pitched or flat roof surface that is exposed to ambient conditions is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Roofs/Roof``.
308
+
309
+ 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``.
310
+
311
+ ====================================== ================ ============ ================= ========= ============================== ==================================
312
+ Element Type Units Constraints Required Default Notes
313
+ ====================================== ================ ============ ================= ========= ============================== ==================================
314
+ ``SystemIdentifier`` id Yes Unique identifier
315
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
316
+ ``Area`` double ft2 > 0 Yes Gross area (including skylights)
317
+ ``Azimuth`` integer deg 0 - 359 No See [#]_ Azimuth (clockwise from North)
318
+ ``RoofType`` string See [#]_ No asphalt or fiberglass shingles Roof type
319
+ ``SolarAbsorptance`` or ``RoofColor`` double or string 0 - 1 or See [#]_ Yes See [#]_ Solar absorptance or color
320
+ ``Emittance`` double 0 - 1 No 0.90 Emittance
321
+ ``Pitch`` integer ?:12 >= 0 Yes Pitch
322
+ ``RadiantBarrier`` boolean No false Presence of radiant barrier
323
+ ``RadiantBarrierGrade`` integer 1 - 3 See [#]_ Radiant barrier installation grade
324
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
325
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
326
+ ====================================== ================ ============ ================= ========= ============================== ==================================
327
+
328
+ .. [#] InteriorAdjacentTo choices are "attic - vented", "attic - unvented", "living space", or "garage".
329
+ See :ref:`hpxmllocations` for descriptions.
330
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
331
+ .. [#] RoofType choices are "asphalt or fiberglass shingles", "wood shingles or shakes", "slate or tile shingles", or "metal surfacing".
332
+ .. [#] RoofColor choices are "light", "medium", "medium dark", "dark", or "reflective".
333
+ .. [#] If SolarAbsorptance not provided, defaults based on RoofColor/RoofType:
334
+
335
+ - **asphalt or fiberglass shingles**: dark=0.92, medium dark=0.89, medium=0.85, light=0.75, reflective=0.50
336
+ - **wood shingles or shakes**: dark=0.92, medium dark=0.89, medium=0.85, light=0.75, reflective=0.50
337
+ - **slate or tile shingles**: dark=0.90, medium dark=0.83, medium=0.75, light=0.60, reflective=0.30
338
+ - **metal surfacing**: dark=0.90, medium dark=0.83, medium=0.75, light=0.60, reflective=0.30
339
+
340
+ .. [#] RadiantBarrierGrade only required if RadiantBarrier is provided.
341
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
342
+
343
+ HPXML Rim Joists
344
+ ****************
345
+
346
+ Each rim joist surface (i.e., the perimeter of floor joists typically found between stories of a building or on top of a foundation wall) is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/RimJoists/RimJoist``.
347
+
348
+ ====================================== ================ ============ ================= ======== =========== ==============================
349
+ Element Type Units Constraints Required Default Notes
350
+ ====================================== ================ ============ ================= ======== =========== ==============================
351
+ ``SystemIdentifier`` id Yes Unique identifier
352
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type
353
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
354
+ ``Area`` double ft2 > 0 Yes Gross area
355
+ ``Azimuth`` integer deg 0 - 359 No See [#]_ Azimuth (clockwise from North)
356
+ ``Siding`` string See [#]_ No wood siding Siding material
357
+ ``SolarAbsorptance`` or ``Color`` double or string 0 - 1 or See [#]_ Yes See [#]_ Solar absorptance or color
358
+ ``Emittance`` double 0 - 1 No 0.90 Emittance
359
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
360
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
361
+ ====================================== ================ ============ ================= ======== =========== ==============================
362
+
363
+ .. [#] ExteriorAdjacentTo choices are "outside", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "garage", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
364
+ See :ref:`hpxmllocations` for descriptions.
365
+ .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
366
+ See :ref:`hpxmllocations` for descriptions.
367
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
368
+ .. [#] Siding choices are "wood siding", "vinyl siding", "stucco", "fiber cement siding", "brick veneer", or "aluminum siding".
369
+ .. [#] Color choices are "light", "medium", "medium dark", "dark", or "reflective".
370
+ .. [#] If SolarAbsorptance not provided, defaults based on Color:
371
+
372
+ - **dark**: 0.95
373
+ - **medium dark**: 0.85
374
+ - **medium**: 0.70
375
+ - **light**: 0.50
376
+ - **reflective**: 0.30
377
+
378
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
379
+
380
+ HPXML Walls
381
+ ***********
382
+
383
+ Each wall that has no contact with the ground and bounds a space type is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Walls/Wall``.
384
+
385
+ ====================================== ================ ============ ================= ============= =========== ====================================
386
+ Element Type Units Constraints Required Default Notes
387
+ ====================================== ================ ============ ================= ============= =========== ====================================
388
+ ``SystemIdentifier`` id Yes Unique identifier
389
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type
390
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
391
+ ``WallType`` element 1 [#]_ Yes Wall type (for thermal mass)
392
+ ``Area`` double ft2 > 0 Yes Gross area (including doors/windows)
393
+ ``Azimuth`` integer deg 0 - 359 No See [#]_ Azimuth (clockwise from North)
394
+ ``Siding`` string See [#]_ No wood siding Siding material
395
+ ``SolarAbsorptance`` or ``Color`` double or string 0 - 1 or See [#]_ Yes See [#]_ Solar absorptance or color
396
+ ``Emittance`` double 0 - 1 No 0.90 Emittance
397
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
398
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
399
+ ====================================== ================ ============ ================= ============= =========== ====================================
400
+
401
+ .. [#] ExteriorAdjacentTo choices are "outside", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "garage", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
402
+ See :ref:`hpxmllocations` for descriptions.
403
+ .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
404
+ See :ref:`hpxmllocations` for descriptions.
405
+ .. [#] WallType child element choices are ``WoodStud``, ``DoubleWoodStud``, ``ConcreteMasonryUnit``, ``StructurallyInsulatedPanel``, ``InsulatedConcreteForms``, ``SteelFrame``, ``SolidConcrete``, ``StructuralBrick``, ``StrawBale``, ``Stone``, ``LogWall``, or ``Adobe``.
406
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
407
+ .. [#] Siding choices are "wood siding", "vinyl siding", "stucco", "fiber cement siding", "brick veneer", or "aluminum siding".
408
+ .. [#] Color choices are "light", "medium", "medium dark", "dark", or "reflective".
409
+ .. [#] If SolarAbsorptance not provided, defaults based on Color:
410
+
411
+ - **dark**: 0.95
412
+ - **medium dark**: 0.85
413
+ - **medium**: 0.70
414
+ - **light**: 0.50
415
+ - **reflective**: 0.30
416
+
417
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
418
+
419
+ HPXML Foundation Walls
420
+ **********************
421
+
422
+ Each wall that is in contact with the ground should be specified as an ``/HPXML/Building/BuildingDetails/Enclosure/FoundationWalls/FoundationWall``.
423
+
424
+ Other walls (e.g., wood framed walls) that are connected to a below-grade space but have no contact with the ground should be specified as a ``Wall`` and not a ``FoundationWall``.
425
+
426
+ ============================================================== ======== ============ =========== ========= ======== ====================================
427
+ Element Type Units Constraints Required Default Notes
428
+ ============================================================== ======== ============ =========== ========= ======== ====================================
429
+ ``SystemIdentifier`` id Yes Unique identifier
430
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type [#]_
431
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
432
+ ``Height`` double ft > 0 Yes Total height
433
+ ``Area`` double ft2 > 0 Yes Gross area (including doors/windows)
434
+ ``Azimuth`` integer deg 0 - 359 No See [#]_ Azimuth (clockwise from North)
435
+ ``Thickness`` double inches > 0 No 8.0 Thickness excluding interior framing
436
+ ``DepthBelowGrade`` double ft 0 - Height Yes Depth below grade [#]_
437
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
438
+ ``Insulation/Layer[InstallationType="continuous - interior"]`` element 0 - 1 See [#]_ Interior insulation layer
439
+ ``Insulation/Layer[InstallationType="continuous - exterior"]`` element 0 - 1 See [#]_ Exterior insulation layer
440
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 See [#]_ Assembly R-value [#]_
441
+ ============================================================== ======== ============ =========== ========= ======== ====================================
442
+
443
+ .. [#] ExteriorAdjacentTo choices are "ground", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "garage", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
444
+ See :ref:`hpxmllocations` for descriptions.
445
+ .. [#] InteriorAdjacentTo choices are "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
446
+ See :ref:`hpxmllocations` for descriptions.
447
+ .. [#] Interior foundation walls (e.g., between basement and crawlspace) should **not** use "ground" even if the foundation wall has some contact with the ground due to the difference in below-grade depths of the two adjacent spaces.
448
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
449
+ .. [#] For exterior foundation walls, depth below grade is relative to the ground plane.
450
+ For interior foundation walls, depth below grade is the vertical span of foundation wall in contact with the ground.
451
+ For example, an interior foundation wall between an 8 ft conditioned basement and a 3 ft crawlspace has a height of 8 ft and a depth below grade of 5 ft.
452
+ Alternatively, an interior foundation wall between an 8 ft conditioned basement and an 8 ft unconditioned basement has a height of 8 ft and a depth below grade of 0 ft.
453
+ .. [#] Layer[InstallationType="continuous - interior"] only required if AssemblyEffectiveRValue is not provided.
454
+ .. [#] Layer[InstallationType="continuous - exterior"] only required if AssemblyEffectiveRValue is not provided.
455
+ .. [#] AssemblyEffectiveRValue only required if Layer elements are not provided.
456
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior air film, and insulation installation grade.
457
+ R-value should **not** include exterior air film (for any above-grade exposure) or any soil thermal resistance.
458
+
459
+ If insulation layers are provided, additional information is entered in each ``FoundationWall/Insulation/Layer``.
460
+
461
+ ========================================== ======== ============ ================================== ======== ======= =====================================================================
462
+ Element Type Units Constraints Required Default Notes
463
+ ========================================== ======== ============ ================================== ======== ======= =====================================================================
464
+ ``NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of the foundation wall insulation; use zero if no insulation
465
+ ``extension/DistanceToTopOfInsulation`` double ft >= 0 Yes Vertical distance from top of foundation wall to top of insulation
466
+ ``extension/DistanceToBottomOfInsulation`` double ft DistanceToTopOfInsulation - Height Yes Vertical distance from top of foundation wall to bottom of insulation
467
+ ========================================== ======== ============ ================================== ======== ======= =====================================================================
468
+
469
+ HPXML Frame Floors
470
+ ******************
471
+
472
+ Each horizontal 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``.
473
+
474
+ ====================================== ======== ============ =========== ======== ======= ============================
475
+ Element Type Units Constraints Required Default Notes
476
+ ====================================== ======== ============ =========== ======== ======= ============================
477
+ ``SystemIdentifier`` id Yes Unique identifier
478
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type
479
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
480
+ ``Area`` double ft2 > 0 Yes Gross area
481
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
482
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
483
+ ====================================== ======== ============ =========== ======== ======= ============================
484
+
485
+ .. [#] ExteriorAdjacentTo choices are "outside", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "garage", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
486
+ See :ref:`hpxmllocations` for descriptions.
487
+ .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
488
+ See :ref:`hpxmllocations` for descriptions.
489
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
490
+
491
+ 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``.
492
+
493
+ ====================================== ======== ===== ============== ======== ======= ==========================================
494
+ Element Type Units Constraints Required Default Notes
495
+ ====================================== ======== ===== ============== ======== ======= ==========================================
496
+ ``extension/OtherSpaceAboveOrBelow`` string See [#]_ Yes Specifies if above/below the MF space type
497
+ ====================================== ======== ===== ============== ======== ======= ==========================================
498
+
499
+ .. [#] OtherSpaceAboveOrBelow choices are "above" or "below".
500
+
501
+ HPXML Slabs
502
+ ***********
503
+
504
+ Each space type that borders the ground (i.e., basements, crawlspaces, garages, and slab-on-grade foundations) should have a slab entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Slabs/Slab``.
505
+
506
+ =========================================== ======== ============ =========== ========= ======== ====================================================
507
+ Element Type Units Constraints Required Default Notes
508
+ =========================================== ======== ============ =========== ========= ======== ====================================================
509
+ ``SystemIdentifier`` id Yes Unique identifier
510
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
511
+ ``Area`` double ft2 > 0 Yes Gross area
512
+ ``Thickness`` double inches >= 0 No See [#]_ Thickness [#]_
513
+ ``ExposedPerimeter`` double ft >= 0 Yes Perimeter exposed to ambient conditions [#]_
514
+ ``PerimeterInsulationDepth`` double ft >= 0 Yes Depth from grade to bottom of vertical insulation
515
+ ``UnderSlabInsulationWidth`` double ft >= 0 See [#]_ Width from slab edge inward of horizontal insulation
516
+ ``UnderSlabInsulationSpansEntireSlab`` boolean See [#]_ Whether horizontal insulation spans entire slab
517
+ ``DepthBelowGrade`` double ft >= 0 See [#]_ Depth from the top of the slab surface to grade
518
+ ``PerimeterInsulation/SystemIdentifier`` id Yes Unique identifier
519
+ ``PerimeterInsulation/Layer/NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of vertical insulation
520
+ ``UnderSlabInsulation/SystemIdentifier`` id Yes Unique identifier
521
+ ``UnderSlabInsulation/Layer/NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of horizontal insulation
522
+ ``extension/CarpetFraction`` double frac 0 - 1 No See [#]_ Fraction of slab covered by carpet
523
+ ``extension/CarpetRValue`` double F-ft2-hr/Btu >= 0 No See [#]_ Carpet R-value
524
+ =========================================== ======== ============ =========== ========= ======== ====================================================
525
+
526
+ .. [#] InteriorAdjacentTo choices are "living space", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
527
+ See :ref:`hpxmllocations` for descriptions.
528
+ .. [#] If Thickness not provided, defaults to 0 when adjacent to crawlspace and 4 inches for all other cases.
529
+ .. [#] For a crawlspace with a dirt floor, enter a thickness of zero.
530
+ .. [#] ExposedPerimeter includes any slab length that falls along the perimeter of the building's footprint (i.e., is exposed to ambient conditions).
531
+ So a basement slab edge adjacent to a garage or crawlspace, for example, should not be included.
532
+ .. [#] UnderSlabInsulationWidth only required if UnderSlabInsulationSpansEntireSlab=true is not provided.
533
+ .. [#] UnderSlabInsulationSpansEntireSlab=true only required if UnderSlabInsulationWidth is not provided.
534
+ .. [#] DepthBelowGrade only required if the attached foundation has no ``FoundationWalls``.
535
+ For foundation types with walls, the the slab's position relative to grade is determined by the ``FoundationWall/DepthBelowGrade`` value.
536
+ .. [#] If CarpetFraction not provided, defaults to 0.8 when adjacent to conditioned space, otherwise 0.0.
537
+ .. [#] If CarpetRValue not provided, defaults to 2.0 when adjacent to conditioned space, otherwise 0.0.
538
+
539
+ .. _windowinputs:
540
+
541
+ HPXML Windows
542
+ *************
543
+
544
+ Each window or glass door area is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Windows/Window``.
545
+
546
+ ============================================ ======== ============ =========== ======== ========= =============================================================
547
+ Element Type Units Constraints Required Default Notes
548
+ ============================================ ======== ============ =========== ======== ========= =============================================================
549
+ ``SystemIdentifier`` id Yes Unique identifier
550
+ ``Area`` double ft2 > 0 Yes Total area
551
+ ``Azimuth`` integer deg 0 - 359 Yes Azimuth (clockwise from North)
552
+ ``UFactor`` double Btu/F-ft2-hr > 0 Yes Full-assembly NFRC U-factor
553
+ ``SHGC`` double 0 - 1 Yes Full-assembly NFRC solar heat gain coefficient
554
+ ``ExteriorShading/SummerShadingCoefficient`` double frac 0 - 1 No 1.00 Exterior summer shading coefficient (1=transparent, 0=opaque)
555
+ ``ExteriorShading/WinterShadingCoefficient`` double frac 0 - 1 No 1.00 Exterior winter shading coefficient (1=transparent, 0=opaque)
556
+ ``InteriorShading/SummerShadingCoefficient`` double frac 0 - 1 No 0.70 [#]_ Interior summer shading coefficient (1=transparent, 0=opaque)
557
+ ``InteriorShading/WinterShadingCoefficient`` double frac 0 - 1 No 0.85 [#]_ Interior winter shading coefficient (1=transparent, 0=opaque)
558
+ ``Overhangs`` element 0 - 1 No <none> Presence of overhangs (including roof eaves)
559
+ ``FractionOperable`` double frac 0 - 1 No 0.67 Operable fraction [#]_
560
+ ``AttachedToWall`` idref See [#]_ Yes ID of attached wall
561
+ ============================================ ======== ============ =========== ======== ========= =============================================================
562
+
563
+ .. [#] InteriorShading/SummerShadingCoefficient default value indicates 30% reduction in solar heat gain, based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
564
+ .. [#] InteriorShading/WinterShadingCoefficient default value indicates 15% reduction in solar heat gain, based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
565
+ .. [#] FractionOperable reflects whether the windows are operable (can be opened), not how they are used by the occupants.
566
+ If a ``Window`` represents a single window, the value should be 0 or 1.
567
+ If a ``Window`` represents multiple windows (e.g., 4), the value should be between 0 and 1 (e.g., 0, 0.25, 0.5, 0.75, or 1).
568
+ 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.
569
+ .. [#] AttachedToWall must reference a ``Wall`` or ``FoundationWall``.
570
+
571
+ If overhangs are specified, additional information is entered in ``Overhangs``.
572
+
573
+ ============================ ======== ====== ======================= ======== ======= ========================================================
574
+ Element Type Units Constraints Required Default Notes
575
+ ============================ ======== ====== ======================= ======== ======= ========================================================
576
+ ``Depth`` double inches >= 0 Yes Depth of overhang
577
+ ``DistanceToTopOfWindow`` double ft >= 0 Yes Vertical distance from overhang to top of window
578
+ ``DistanceToBottomOfWindow`` double ft > DistanceToTopOfWindow Yes Vertical distance from overhang to bottom of window [#]_
579
+ ============================ ======== ====== ======================= ======== ======= ========================================================
580
+
581
+ .. [#] The difference between DistanceToBottomOfWindow and DistanceToTopOfWindow defines the height of the window.
582
+
583
+ HPXML Skylights
584
+ ***************
585
+
586
+ Each skylight is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Skylights/Skylight``.
587
+
588
+ ============================================ ======== ============ =========== ======== ========== =============================================================
589
+ Element Type Units Constraints Required Default Notes
590
+ ============================================ ======== ============ =========== ======== ========== =============================================================
591
+ ``SystemIdentifier`` id Yes Unique identifier
592
+ ``Area`` double ft2 > 0 Yes Total area
593
+ ``Azimuth`` integer deg 0 - 359 Yes Azimuth (clockwise from North)
594
+ ``UFactor`` double Btu/F-ft2-hr > 0 Yes Full-assembly NFRC U-factor
595
+ ``SHGC`` double 0 - 1 Yes Full-assembly NFRC solar heat gain coefficient
596
+ ``ExteriorShading/SummerShadingCoefficient`` double frac 0 - 1 No 1.00 Exterior summer shading coefficient (1=transparent, 0=opaque)
597
+ ``ExteriorShading/WinterShadingCoefficient`` double frac 0 - 1 No 1.00 Exterior winter shading coefficient (1=transparent, 0=opaque)
598
+ ``InteriorShading/SummerShadingCoefficient`` double frac 0 - 1 No 1.00 Interior summer shading coefficient (1=transparent, 0=opaque)
599
+ ``InteriorShading/WinterShadingCoefficient`` double frac 0 - 1 No 1.00 Interior winter shading coefficient (1=transparent, 0=opaque)
600
+ ``AttachedToRoof`` idref See [#]_ Yes ID of attached roof
601
+ ============================================ ======== ============ =========== ======== ========== =============================================================
602
+
603
+ .. [#] AttachedToRoof must reference a ``Roof``.
604
+
605
+ HPXML Doors
606
+ ***********
607
+
608
+ Each opaque door is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Doors/Door``.
609
+
610
+ ============================================ ======== ============ =========== ======== ========= ==============================
611
+ Element Type Units Constraints Required Default Notes
612
+ ============================================ ======== ============ =========== ======== ========= ==============================
613
+ ``SystemIdentifier`` id Yes Unique identifier
614
+ ``AttachedToWall`` idref See [#]_ Yes ID of attached wall
615
+ ``Area`` double ft2 > 0 Yes Total area
616
+ ``Azimuth`` integer deg 0 - 359 Yes Azimuth (clockwise from North)
617
+ ``RValue`` double F-ft2-hr/Btu > 0 Yes R-value
618
+ ============================================ ======== ============ =========== ======== ========= ==============================
619
+
620
+ .. [#] AttachedToWall must reference a ``Wall`` or ``FoundationWall``.
621
+
622
+ HPXML Systems
623
+ -------------
624
+
625
+ The dwelling unit's systems are entered in ``/HPXML/Building/BuildingDetails/Systems``.
626
+
627
+ .. _hvac_heating:
628
+
629
+ HPXML Heating Systems
630
+ *********************
631
+
632
+ Each heating system (other than a heat pump) is entered as an ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/HeatingSystem``.
633
+
634
+ ================================= ======== ====== =========== ======== ========= ===============================
635
+ Element Type Units Constraints Required Default Notes
636
+ ================================= ======== ====== =========== ======== ========= ===============================
637
+ ``SystemIdentifier`` id Yes Unique identifier
638
+ ``HeatingSystemType`` element 1 [#]_ Yes Type of heating system
639
+ ``HeatingSystemFuel`` string See [#]_ Yes Fuel type
640
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Input heating capacity
641
+ ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
642
+ ================================= ======== ====== =========== ======== ========= ===============================
643
+
644
+ .. [#] HeatingSystemType child element choices are ``ElectricResistance``, ``Furnace``, ``WallFurnace``, ``FloorFurnace``, ``Boiler``, ``Stove``, ``PortableHeater``, ``FixedHeater``, or ``Fireplace``.
645
+ .. [#] 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".
646
+ For ``ElectricResistance``, "electricity" is required.
647
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
648
+
649
+ Electric Resistance
650
+ ~~~~~~~~~~~~~~~~~~~
651
+
652
+ If electric resistance heating is specified, additional information is entered in ``HeatingSystem``.
653
+
654
+ ================================================== ====== ===== =========== ======== ======= ==========
655
+ Element Type Units Constraints Required Default Notes
656
+ ================================================== ====== ===== =========== ======== ======= ==========
657
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
658
+ ================================================== ====== ===== =========== ======== ======= ==========
659
+
660
+ Furnace
661
+ ~~~~~~~
662
+
663
+ If a furnace is specified, additional information is entered in ``HeatingSystem``.
664
+
665
+ =============================================== ====== ===== =========== ======== ========= ================================================
666
+ Element Type Units Constraints Required Default Notes
667
+ =============================================== ====== ===== =========== ======== ========= ================================================
668
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
669
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0 - 1 Yes Rated efficiency
670
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Fan power [#]_
671
+ ``extension/AirflowDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed airflows [#]_
672
+ =============================================== ====== ===== =========== ======== ========= ================================================
673
+
674
+ .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity" or "gravity") or DSE.
675
+ .. [#] 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.
676
+ .. [#] If there is a cooling system attached to the DistributionSystem, the heating and cooling systems cannot have different values for FanPowerWattsPerCFM.
677
+ .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
678
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
679
+
680
+ Wall/Floor Furnace
681
+ ~~~~~~~~~~~~~~~~~~
682
+
683
+ If a wall furnace or floor furnace is specified, additional information is entered in ``HeatingSystem``.
684
+
685
+ =============================================== ====== ===== =========== ======== ======= ===================
686
+ Element Type Units Constraints Required Default Notes
687
+ =============================================== ====== ===== =========== ======== ======= ===================
688
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0 - 1 Yes Rated efficiency
689
+ ``extension/FanPowerWatts`` double W >= 0 No 0 Fan power
690
+ =============================================== ====== ===== =========== ======== ======= ===================
691
+
692
+ .. _hvac_heating_boiler:
693
+
694
+ Boiler
695
+ ~~~~~~
696
+
697
+ If a boiler is specified, additional information is entered in ``HeatingSystem``.
698
+
699
+ ========================================================================== ======== ====== =========== ======== ======== =========================================
700
+ Element Type Units Constraints Required Default Notes
701
+ ========================================================================== ======== ====== =========== ======== ======== =========================================
702
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
703
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
704
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0 - 1 Yes Rated efficiency
705
+ ========================================================================== ======== ====== =========== ======== ======== =========================================
706
+
707
+ .. [#] For in-unit boilers, HVACDistribution type must be HydronicDistribution (type: "radiator", "baseboard", "radiant floor", "radiant ceiling", or "water loop") or DSE.
708
+ For shared boilers, HVACDistribution type must be HydronicDistribution (type: "radiator", "baseboard", "radiant floor", "radiant ceiling", or "water loop") or AirDistribution (type: "fan coil").
709
+ If the shared boiler has "water loop" distribution, a :ref:`hvac_heatpump_wlhp` must also be specified.
710
+
711
+ If an in-unit boiler if specified, additional information is entered in ``HeatingSystem``.
712
+
713
+ =========================== ======== ====== =========== ======== ======== =========================
714
+ Element Type Units Constraints Required Default Notes
715
+ =========================== ======== ====== =========== ======== ======== =========================
716
+ ``ElectricAuxiliaryEnergy`` double kWh/yr >= 0 No See [#]_ Electric auxiliary energy
717
+ =========================== ======== ====== =========== ======== ======== =========================
718
+
719
+ .. [#] If ElectricAuxiliaryEnergy not provided, defaults as follows:
720
+
721
+ - **Oil boiler**: 330 kWh/yr
722
+ - **Gas boiler**: 170 kWh/yr
723
+
724
+ If instead a shared boiler is specified, additional information is entered in ``HeatingSystem``.
725
+
726
+ ============================================================ ======== =========== =========== ======== ======== =========================
727
+ Element Type Units Constraints Required Default Notes
728
+ ============================================================ ======== =========== =========== ======== ======== =========================
729
+ ``NumberofUnitsServed`` integer > 1 Yes Number of dwelling units served
730
+ ``ElectricAuxiliaryEnergy`` or ``extension/SharedLoopWatts`` double kWh/yr or W >= 0 No See [#]_ Electric auxiliary energy or shared loop power
731
+ ``ElectricAuxiliaryEnergy`` or ``extension/FanCoilWatts`` double kWh/yr or W >= 0 No [#]_ Electric auxiliary energy or fan coil power
732
+ ============================================================ ======== =========== =========== ======== ======== =========================
733
+
734
+ .. [#] If ElectricAuxiliaryEnergy nor SharedLoopWatts provided, defaults as follows:
735
+
736
+ - **Shared boiler w/ baseboard**: 220 kWh/yr
737
+ - **Shared boiler w/ water loop heat pump**: 265 kWh/yr
738
+ - **Shared boiler w/ fan coil**: 438 kWh/yr
739
+
740
+ .. [#] FanCoilWatts only used if boiler connected to fan coil and SharedLoopWatts provided.
741
+
742
+ Stove
743
+ ~~~~~
744
+
745
+ If a stove is specified, additional information is entered in ``HeatingSystem``.
746
+
747
+ ================================================== ====== ===== =========== ======== ========= ===================
748
+ Element Type Units Constraints Required Default Notes
749
+ ================================================== ====== ===== =========== ======== ========= ===================
750
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
751
+ ``extension/FanPowerWatts`` double W >= 0 No 40 Fan power
752
+ ================================================== ====== ===== =========== ======== ========= ===================
753
+
754
+ Portable/Fixed Heater
755
+ ~~~~~~~~~~~~~~~~~~~~~
756
+
757
+ If a portable heater or fixed heater is specified, additional information is entered in ``HeatingSystem``.
758
+
759
+ ================================================== ====== ===== =========== ======== ========= ===================
760
+ Element Type Units Constraints Required Default Notes
761
+ ================================================== ====== ===== =========== ======== ========= ===================
762
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
763
+ ``extension/FanPowerWatts`` double W >= 0 No 0 Fan power
764
+ ================================================== ====== ===== =========== ======== ========= ===================
765
+
766
+ Fireplace
767
+ ~~~~~~~~~
768
+
769
+ If a fireplace is specified, additional information is entered in ``HeatingSystem``.
770
+
771
+ ================================================== ====== ===== =========== ======== ========= ===================
772
+ Element Type Units Constraints Required Default Notes
773
+ ================================================== ====== ===== =========== ======== ========= ===================
774
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0 - 1 Yes Efficiency
775
+ ``extension/FanPowerWatts`` double W >= 0 No 0 Fan power
776
+ ================================================== ====== ===== =========== ======== ========= ===================
777
+
778
+ .. _hvac_cooling:
779
+
780
+ HPXML Cooling Systems
781
+ *********************
782
+
783
+ Each cooling system (other than a heat pump) is entered as an ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/CoolingSystem``.
784
+
785
+ ========================== ======== ====== =========== ======== ======= ===============================
786
+ Element Type Units Constraints Required Default Notes
787
+ ========================== ======== ====== =========== ======== ======= ===============================
788
+ ``SystemIdentifier`` id Yes Unique identifier
789
+ ``CoolingSystemType`` string See [#]_ Yes Type of cooling system
790
+ ``CoolingSystemFuel`` string See [#]_ Yes Fuel type
791
+ ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
792
+ ========================== ======== ====== =========== ======== ======= ===============================
793
+
794
+ .. [#] CoolingSystemType choices are "central air conditioner", "room air conditioner", "evaporative cooler", "mini-split", "chiller", or "cooling tower".
795
+ .. [#] CoolingSystemFuel only choice is "electricity".
796
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
797
+
798
+ Central Air Conditioner
799
+ ~~~~~~~~~~~~~~~~~~~~~~~
800
+
801
+ If a central air conditioner is specified, additional information is entered in ``CoolingSystem``.
802
+
803
+ =============================================== ======== ====== =========== ======== ========= ================================================
804
+ Element Type Units Constraints Required Default Notes
805
+ =============================================== ======== ====== =========== ======== ========= ================================================
806
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
807
+ ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated efficiency
808
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
809
+ ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
810
+ ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
811
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Fan power [#]_
812
+ ``extension/AirflowDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed airflows [#]_
813
+ ``extension/ChargeDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed charges [#]_
814
+ =============================================== ======== ====== =========== ======== ========= ================================================
815
+
816
+ .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
817
+ .. [#] CompressorType choices are "single stage", "two stage", or "variable speed".
818
+ .. [#] If CompressorType not provided, defaults to "single stage" if SEER <= 15, else "two stage" if SEER <= 21, else "variable speed".
819
+ .. [#] 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.
820
+ .. [#] If there is a heating system attached to the DistributionSystem, the heating and cooling systems cannot have different values for FanPowerWattsPerCFM.
821
+ .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
822
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
823
+ .. [#] ChargeDefectRatio is defined as (InstalledCharge - DesignCharge) / DesignCharge; a value of zero means no refrigerant charge defect.
824
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
825
+
826
+ Room Air Conditioner
827
+ ~~~~~~~~~~~~~~~~~~~~
828
+
829
+ If a room air conditioner is specified, additional information is entered in ``CoolingSystem``.
830
+
831
+ ============================================== ======== ====== =========== ======== ========= ======================
832
+ Element Type Units Constraints Required Default Notes
833
+ ============================================== ======== ====== =========== ======== ========= ======================
834
+ ``AnnualCoolingEfficiency[Units="EER"]/Value`` double Btu/Wh > 0 Yes Rated efficiency
835
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
836
+ ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
837
+ ============================================== ======== ====== =========== ======== ========= ======================
838
+
839
+ Evaporative Cooler
840
+ ~~~~~~~~~~~~~~~~~~
841
+
842
+ If an evaporative cooler is specified, additional information is entered in ``CoolingSystem``.
843
+
844
+ ================================= ======== ====== =========== ======== ========= ==================================
845
+ Element Type Units Constraints Required Default Notes
846
+ ================================= ======== ====== =========== ======== ========= ==================================
847
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system
848
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
849
+ ================================= ======== ====== =========== ======== ========= ==================================
850
+
851
+ .. [#] If provided, HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
852
+
853
+ Mini-Split
854
+ ~~~~~~~~~~
855
+
856
+ If a mini-split is specified, additional information is entered in ``CoolingSystem``.
857
+
858
+ =============================================== ======== ====== =========== ======== ========= ===============================================
859
+ Element Type Units Constraints Required Default Notes
860
+ =============================================== ======== ====== =========== ======== ========= ===============================================
861
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system
862
+ ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
863
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
864
+ ``SensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
865
+ ``extension/ChargeDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed charges [#]_
866
+ =============================================== ======== ====== =========== ======== ========= ===============================================
867
+
868
+ .. [#] If provided, HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
869
+ .. [#] ChargeDefectRatio is defined as (InstalledCharge - DesignCharge) / DesignCharge; a value of zero means no refrigerant charge defect.
870
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
871
+
872
+ If a ducted mini-split is specified (i.e., a ``DistributionSystem`` has been entered), additional information is entered in ``CoolingSystem``.
873
+
874
+ ================================= ======== ====== =========== ======== ========= ===============================================
875
+ Element Type Units Constraints Required Default Notes
876
+ ================================= ======== ====== =========== ======== ========= ===============================================
877
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No 0.18 Fan power
878
+ ``extension/AirflowDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed airflows [#]_
879
+ ================================= ======== ====== =========== ======== ========= ===============================================
880
+
881
+ .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
882
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
883
+
884
+ .. _hvac_cooling_chiller:
885
+
886
+ Chiller
887
+ ~~~~~~~
888
+
889
+ If a chiller is specified, additional information is entered in ``CoolingSystem``.
890
+
891
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
892
+ Element Type Units Constraints Required Default Notes
893
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
894
+ ``IsSharedSystem`` boolean true Yes Whether it serves multiple dwelling units
895
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
896
+ ``NumberofUnitsServed`` integer > 1 Yes Number of dwelling units served
897
+ ``CoolingCapacity`` double Btu/hr >= 0 Yes Total cooling capacity
898
+ ``AnnualCoolingEfficiency[Units="kW/ton"]/Value`` double kW/ton > 0 Yes Rated efficiency
899
+ ``extension/SharedLoopWatts`` double W >= 0 Yes Pumping and fan power serving the system
900
+ ``extension/FanCoilWatts`` double W >= 0 See [#]_ Fan coil power
901
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
902
+
903
+ .. [#] HVACDistribution type must be HydronicDistribution (type: "radiator", "baseboard", "radiant floor", "radiant ceiling", or "water loop") or AirDistribution (type: "fan coil").
904
+ If the chiller has "water loop" distribution, a :ref:`hvac_heatpump_wlhp` must also be specified.
905
+ .. [#] FanCoilWatts only required if chiller connected to fan coil.
906
+
907
+ .. note::
908
+
909
+ Chillers are modeled as central air conditioners with a SEER equivalent using the equation from `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
910
+
911
+ .. _hvac_cooling_tower:
912
+
913
+ Cooling Tower
914
+ ~~~~~~~~~~~~~
915
+
916
+ If a cooling tower is specified, additional information is entered in ``CoolingSystem``.
917
+
918
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
919
+ Element Type Units Constraints Required Default Notes
920
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
921
+ ``IsSharedSystem`` boolean true Yes Whether it serves multiple dwelling units
922
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
923
+ ``NumberofUnitsServed`` integer > 1 Yes Number of dwelling units served
924
+ ``extension/SharedLoopWatts`` double W >= 0 Yes Pumping and fan power serving the system
925
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
926
+
927
+ .. [#] HVACDistribution type must be HydronicDistribution (type: "water loop").
928
+ A :ref:`hvac_heatpump_wlhp` must also be specified.
929
+
930
+ .. note::
931
+
932
+ Cooling towers w/ water loop heat pumps are modeled as central air conditioners with a SEER equivalent using the equation from `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
933
+
934
+ .. _hvac_heatpump:
935
+
936
+ HPXML Heat Pumps
937
+ ****************
938
+
939
+ Each heat pump is entered as an ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/HeatPump``.
940
+
941
+ ================================= ======== ====== =========== ======== ========= ===============================================
942
+ Element Type Units Constraints Required Default Notes
943
+ ================================= ======== ====== =========== ======== ========= ===============================================
944
+ ``SystemIdentifier`` id Yes Unique identifier
945
+ ``HeatPumpType`` string See [#]_ Yes Type of heat pump
946
+ ``HeatPumpFuel`` string See [#]_ Yes Fuel type
947
+ ``BackupSystemFuel`` string See [#]_ No Fuel type of backup heating, if present
948
+ ================================= ======== ====== =========== ======== ========= ===============================================
949
+
950
+ .. [#] HeatPumpType choices are "air-to-air", "mini-split", "ground-to-air", or "water-loop-to-air".
951
+ .. [#] HeatPumpFuel only choice is "electricity".
952
+ .. [#] BackupSystemFuel 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".
953
+
954
+ If a backup system fuel is provided, additional information is entered in ``HeatPump``.
955
+
956
+ ======================================================================== ======== ====== =========== ======== ========= ==========================================
957
+ Element Type Units Constraints Required Default Notes
958
+ ======================================================================== ======== ====== =========== ======== ========= ==========================================
959
+ ``BackupAnnualHeatingEfficiency[Units="Percent" or Units="AFUE"]/Value`` double frac 0 - 1 Yes Backup heating efficiency
960
+ ``BackupHeatingCapacity`` double Btu/hr >= 0 No autosized Backup heating capacity
961
+ ``BackupHeatingSwitchoverTemperature`` double F No <none> Backup heating switchover temperature [#]_
962
+ ======================================================================== ======== ====== =========== ======== ========= ==========================================
963
+
964
+ .. [#] Provide BackupHeatingSwitchoverTemperature for, e.g., a dual-fuel heat pump, in which there is a discrete outdoor temperature when the heat pump stops operating and the backup heating system starts operating.
965
+ If not provided, the backup heating system will operate as needed when the heat pump has insufficient capacity.
966
+
967
+ Air-to-Air Heat Pump
968
+ ~~~~~~~~~~~~~~~~~~~~
969
+
970
+ If an air-to-air heat pump is specified, additional information is entered in ``HeatPump``.
971
+
972
+ =============================================== ======== ====== =========== ======== ========= ================================================
973
+ Element Type Units Constraints Required Default Notes
974
+ =============================================== ======== ====== =========== ======== ========= ================================================
975
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
976
+ ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
977
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating capacity (excluding any backup heating)
978
+ ``HeatingCapacity17F`` double Btu/hr >= 0 No Heating capacity at 17F, if available
979
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
980
+ ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
981
+ ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
982
+ ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
983
+ ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
984
+ ``AnnualHeatingEfficiency[Units="HSPF"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency
985
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Fan power
986
+ ``extension/AirflowDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed airflows [#]_
987
+ ``extension/ChargeDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed charges [#]_
988
+ =============================================== ======== ====== =========== ======== ========= ================================================
989
+
990
+ .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
991
+ .. [#] CompressorType choices are "single stage", "two stage", or "variable speed".
992
+ .. [#] If CompressorType not provided, defaults to "single stage" if SEER <= 15, else "two stage" if SEER <= 21, else "variable speed".
993
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
994
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
995
+ .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.5 W/cfm if HSPF <= 8.75, else 0.375 W/cfm.
996
+ .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
997
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
998
+ .. [#] ChargeDefectRatio is defined as (InstalledCharge - DesignCharge) / DesignCharge; a value of zero means no refrigerant charge defect.
999
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
1000
+
1001
+ Mini-Split Heat Pump
1002
+ ~~~~~~~~~~~~~~~~~~~~
1003
+
1004
+ If a mini-split heat pump is specified, additional information is entered in ``HeatPump``.
1005
+
1006
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1007
+ Element Type Units Constraints Required Default Notes
1008
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1009
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system, if present
1010
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating capacity (excluding any backup heating)
1011
+ ``HeatingCapacity17F`` double Btu/hr >= 0 No Heating capacity at 17F, if available
1012
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
1013
+ ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1014
+ ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1015
+ ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
1016
+ ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
1017
+ ``AnnualHeatingEfficiency[Units="HSPF"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency
1018
+ ``extension/ChargeDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed charges [#]_
1019
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1020
+
1021
+ .. [#] If provided, HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1022
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
1023
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
1024
+ .. [#] ChargeDefectRatio is defined as (InstalledCharge - DesignCharge) / DesignCharge; a value of zero means no refrigerant charge defect.
1025
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
1026
+
1027
+ If a ducted mini-split is specified (i.e., a ``DistributionSystem`` has been entered), additional information is entered in ``HeatPump``.
1028
+
1029
+ ================================= ======== ====== =========== ======== ========= ===============================================
1030
+ Element Type Units Constraints Required Default Notes
1031
+ ================================= ======== ====== =========== ======== ========= ===============================================
1032
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No 0.18 Fan power
1033
+ ``extension/AirflowDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed airflows [#]_
1034
+ ================================= ======== ====== =========== ======== ========= ===============================================
1035
+
1036
+ .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
1037
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
1038
+
1039
+ Ground-to-Air Heat Pump
1040
+ ~~~~~~~~~~~~~~~~~~~~~~~
1041
+
1042
+ If a ground-to-air heat pump is specified, additional information is entered in ``HeatPump``.
1043
+
1044
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1045
+ Element Type Units Constraints Required Default Notes
1046
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1047
+ ``IsSharedSystem`` boolean No false Whether it has a shared hydronic circulation loop [#]_
1048
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1049
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating capacity (excluding any backup heating)
1050
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
1051
+ ``CoolingSensibleHeatFraction`` double frac 0 - 1 No Sensible heat fraction
1052
+ ``FractionHeatLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of heating load served
1053
+ ``FractionCoolLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of cooling load served
1054
+ ``AnnualCoolingEfficiency[Units="EER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
1055
+ ``AnnualHeatingEfficiency[Units="COP"]/Value`` double W/W > 0 Yes Rated heating efficiency
1056
+ ``NumberofUnitsServed`` integer > 0 See [#]_ Number of dwelling units served
1057
+ ``extension/PumpPowerWattsPerTon`` double W/ton >= 0 No See [#]_ Pump power [#]_
1058
+ ``extension/SharedLoopWatts`` double W >= 0 See [#]_ Shared pump power [#]_
1059
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Fan power
1060
+ ``extension/AirflowDefectRatio`` double frac > -1 No 0.0 Deviation between design/installed airflows [#]_
1061
+ ``extension/ChargeDefectRatio`` double frac 0.0 [#]_ No 0.0 Deviation between design/installed charges [#]_
1062
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1063
+
1064
+ .. [#] IsSharedSystem should be true if the SFA/MF building has multiple ground source heat pumps connected to a shared hydronic circulation loop.
1065
+ .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1066
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
1067
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
1068
+ .. [#] NumberofUnitsServed only required if IsSharedSystem is true, in which case it must be > 1.
1069
+ .. [#] 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.
1070
+ .. [#] 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.
1071
+ Any pump power that is shared by multiple dwelling units should be included in SharedLoopWatts, *not* PumpPowerWattsPerTon, so that shared loop pump power attributed to the dwelling unit is calculated.
1072
+ .. [#] SharedLoopWatts only required if IsSharedSystem is true.
1073
+ .. [#] Shared loop pump power attributed to the dwelling unit is calculated as SharedLoopWatts / NumberofUnitsServed.
1074
+ .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.5 W/cfm if COP <= 8.75/3.2, else 0.375 W/cfm.
1075
+ .. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
1076
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
1077
+ .. [#] ChargeDefectRatio currently constrained to zero for ground-to-air heat pumps due to an EnergyPlus limitation; this constraint will be relaxed in the future.
1078
+ .. [#] ChargeDefectRatio is defined as (InstalledCharge - DesignCharge) / DesignCharge; a value of zero means no refrigerant charge defect.
1079
+ See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
1080
+
1081
+ .. _hvac_heatpump_wlhp:
1082
+
1083
+ Water-Loop-to-Air Heat Pump
1084
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1085
+
1086
+ If a water-loop-to-air heat pump is specified, additional information is entered in ``HeatPump``.
1087
+
1088
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1089
+ Element Type Units Constraints Required Default Notes
1090
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1091
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1092
+ ``HeatingCapacity`` double Btu/hr > 0 No autosized Heating capacity
1093
+ ``CoolingCapacity`` double Btu/hr > 0 See [#]_ Cooling capacity
1094
+ ``AnnualCoolingEfficiency[Units="EER"]/Value`` double Btu/Wh > 0 See [#]_ Rated cooling efficiency
1095
+ ``AnnualHeatingEfficiency[Units="COP"]/Value`` double W/W > 0 See [#]_ Rated heating efficiency
1096
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1097
+
1098
+ .. [#] HVACDistribution type must be AirDistribution (type: "regular velocity") or DSE.
1099
+ .. [#] CoolingCapacity required if there is a shared chiller or cooling tower with water loop distribution.
1100
+ .. [#] AnnualCoolingEfficiency required if there is a shared chiller or cooling tower with water loop distribution.
1101
+ .. [#] AnnualHeatingEfficiency required if there is a shared boiler with water loop distribution.
1102
+
1103
+ .. note::
1104
+
1105
+ If a water loop heat pump is specified, there must be at least one shared heating system (i.e., :ref:`hvac_heating_boiler`) and/or one shared cooling system (i.e., :ref:`hvac_cooling_chiller` or :ref:`hvac_cooling_tower`) specified with water loop distribution.
1106
+
1107
+ .. _hvac_control:
1108
+
1109
+ HPXML HVAC Control
1110
+ ******************
1111
+
1112
+ If any HVAC systems are specified, a single thermostat is entered as a ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACControl``.
1113
+
1114
+ ======================================================= ======== ======= =========== ======== ========= ========================================
1115
+ Element Type Units Constraints Required Default Notes
1116
+ ======================================================= ======== ======= =========== ======== ========= ========================================
1117
+ ``SystemIdentifier`` id Yes Unique identifier
1118
+ ``extension/CeilingFanSetpointTempCoolingSeasonOffset`` double F >= 0 No 0 Cooling setpoint temperature offset [#]_
1119
+ ======================================================= ======== ======= =========== ======== ========= ========================================
1120
+
1121
+ .. [#] CeilingFanSetpointTempCoolingSeasonOffset should only be used if there are sufficient ceiling fans present to warrant a reduced cooling setpoint.
1122
+
1123
+ Thermostat setpoints are additionally entered using either simple inputs or detailed inputs.
1124
+
1125
+ Simple Inputs
1126
+ ~~~~~~~~~~~~~
1127
+
1128
+ To define simple thermostat setpoints, additional information is entered in ``HVACControl``.
1129
+
1130
+ ============================= ======== ======= =========== ======== ========= ============================
1131
+ Element Type Units Constraints Required Default Notes
1132
+ ============================= ======== ======= =========== ======== ========= ============================
1133
+ ``SetpointTempHeatingSeason`` double F Yes Heating setpoint temperature
1134
+ ``SetpointTempCoolingSeason`` double F Yes Cooling setpoint temperature
1135
+ ============================= ======== ======= =========== ======== ========= ============================
1136
+
1137
+ If there is a heating temperature setback, additional information is entered in ``HVACControl``.
1138
+
1139
+ ===================================== ======== ======== =========== ======== ========= =========================================
1140
+ Element Type Units Constraints Required Default Notes
1141
+ ===================================== ======== ======== =========== ======== ========= =========================================
1142
+ ``SetbackTempHeatingSeason`` double F Yes Heating setback temperature
1143
+ ``TotalSetbackHoursperWeekHeating`` integer hrs/week > 0 Yes Hours/week of heating temperature setback
1144
+ ``extension/SetbackStartHourHeating`` integer 0 - 23 No 23 (11pm) Daily setback start hour
1145
+ ===================================== ======== ======== =========== ======== ========= =========================================
1146
+
1147
+ If there is a cooling temperature setup, additional information is entered in ``HVACControl``.
1148
+
1149
+ ===================================== ======== ======== =========== ======== ========= =========================================
1150
+ Element Type Units Constraints Required Default Notes
1151
+ ===================================== ======== ======== =========== ======== ========= =========================================
1152
+ ``SetupTempCoolingSeason`` double F Yes Cooling setup temperature
1153
+ ``TotalSetupHoursperWeekCooling`` integer hrs/week > 0 Yes Hours/week of cooling temperature setup
1154
+ ``extension/SetupStartHourCooling`` integer 0 - 23 No 9 (9am) Daily setup start hour
1155
+ ===================================== ======== ======== =========== ======== ========= =========================================
1156
+
1157
+ Detailed Inputs
1158
+ ~~~~~~~~~~~~~~~
1159
+
1160
+ To define detailed thermostat setpoints, additional information is entered in ``HVACControl``.
1161
+
1162
+ =============================================== ===== ======= =========== ======== ========= ============================================
1163
+ Element Type Units Constraints Required Default Notes
1164
+ =============================================== ===== ======= =========== ======== ========= ============================================
1165
+ ``extension/WeekdaySetpointTempsHeatingSeason`` array F Yes 24 comma-separated weekday heating setpoints
1166
+ ``extension/WeekendSetpointTempsHeatingSeason`` array F Yes 24 comma-separated weekend heating setpoints
1167
+ ``extension/WeekdaySetpointTempsCoolingSeason`` array F Yes 24 comma-separated weekday cooling setpoints
1168
+ ``extension/WeekendSetpointTempsCoolingSeason`` array F Yes 24 comma-separated weekend cooling setpoints
1169
+ =============================================== ===== ======= =========== ======== ========= ============================================
1170
+
1171
+ HPXML HVAC Distribution
1172
+ ***********************
1173
+
1174
+ Each separate HVAC distribution system is entered as a ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACDistribution``.
1175
+
1176
+ ============================== ======= ======= =========== ======== ========= =============================
1177
+ Element Type Units Constraints Required Default Notes
1178
+ ============================== ======= ======= =========== ======== ========= =============================
1179
+ ``SystemIdentifier`` id Yes Unique identifier
1180
+ ``DistributionSystemType`` element 1 [#]_ Yes Type of distribution system
1181
+ ``ConditionedFloorAreaServed`` double ft2 > 0 See [#]_ Conditioned floor area served
1182
+ ============================== ======= ======= =========== ======== ========= =============================
1183
+
1184
+ .. [#] DistributionSystemType child element choices are ``AirDistribution``, ``HydronicDistribution``, or ``Other=DSE``.
1185
+ .. [#] ConditionedFloorAreaServed required only when DistributionSystemType is AirDistribution and ``AirDistribution/Ducts`` are present.
1186
+
1187
+ .. note::
1188
+
1189
+ There should be at most one heating system and one cooling system attached to a distribution system.
1190
+ See :ref:`hvac_heating`, :ref:`hvac_cooling`, and :ref:`hvac_heatpump` for information on which DistributionSystemType is allowed for which HVAC system.
1191
+ Also note that some HVAC systems (e.g., room air conditioners) are not allowed to be attached to a distribution system.
1192
+
1193
+ .. _air_distribution:
1194
+
1195
+ Air Distribution
1196
+ ~~~~~~~~~~~~~~~~
1197
+
1198
+ To define an air distribution system, additional information is entered in ``HVACDistribution/DistributionSystemType/AirDistribution``.
1199
+
1200
+ ============================================= ======= ======= =========== ======== ========= ==========================
1201
+ Element Type Units Constraints Required Default Notes
1202
+ ============================================= ======= ======= =========== ======== ========= ==========================
1203
+ ``AirDistributionType`` string See [#]_ Yes Type of air distribution
1204
+ ``DuctLeakageMeasurement[DuctType="supply"]`` element 1 See [#]_ Supply duct leakage value
1205
+ ``DuctLeakageMeasurement[DuctType="return"]`` element 1 See [#]_ Return duct leakage value
1206
+ ``Ducts`` element >= 0 No Supply/return ducts [#]_
1207
+ ``NumberofReturnRegisters`` integer >= 0 No See [#]_ Number of return registers
1208
+ ============================================= ======= ======= =========== ======== ========= ==========================
1209
+
1210
+ .. [#] AirDistributionType choices are "regular velocity", "gravity", or "fan coil" and are further restricted based on attached HVAC system type (e.g., only "regular velocity" or "gravity" for a furnace, only "fan coil" for a shared boiler, etc.).
1211
+ .. [#] Supply duct leakage required if AirDistributionType is "regular velocity" or "gravity" and optional if AirDistributionType is "fan coil".
1212
+ .. [#] Return duct leakage required if AirDistributionType is "regular velocity" or "gravity" and optional if AirDistributionType is "fan coil".
1213
+ .. [#] Provide a Ducts element for each supply duct and each return duct.
1214
+ .. [#] If NumberofReturnRegisters not provided and ``AirDistribution/Ducts`` are present, defaults to one return register per conditioned floor per `ASHRAE Standard 152 <https://www.energy.gov/eere/buildings/downloads/ashrae-standard-152-spreadsheet>`_, rounded up to the nearest integer if needed.
1215
+
1216
+ Additional information is entered in each ``DuctLeakageMeasurement``.
1217
+
1218
+ ================================ ======= ======= =========== ======== ========= =========================================================
1219
+ Element Type Units Constraints Required Default Notes
1220
+ ================================ ======= ======= =========== ======== ========= =========================================================
1221
+ ``DuctLeakage/Units`` string See [#]_ Yes Duct leakage units
1222
+ ``DuctLeakage/Value`` double >= 0 [#]_ Yes Duct leakage value [#]_
1223
+ ``DuctLeakage/TotalOrToOutside`` string See [#]_ Yes Type of duct leakage (outside conditioned space vs total)
1224
+ ================================ ======= ======= =========== ======== ========= =========================================================
1225
+
1226
+ .. [#] Units choices are "CFM25" or "Percent".
1227
+ .. [#] Value also must be < 1 if Units is Percent.
1228
+ .. [#] If the HVAC system has no return ducts (e.g., a ducted evaporative cooler), use zero for the Value.
1229
+ .. [#] TotalOrToOutside only choice is "to outside".
1230
+
1231
+ Additional information is entered in each ``Ducts``.
1232
+
1233
+ ======================== ======= ============ =========== ======== ========= ===============================
1234
+ Element Type Units Constraints Required Default Notes
1235
+ ======================== ======= ============ =========== ======== ========= ===============================
1236
+ ``DuctInsulationRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of duct insulation [#]_
1237
+ ``DuctSurfaceArea`` double ft2 >= 0 See [#]_ See [#]_ Duct surface area
1238
+ ``DuctLocation`` string See [#]_ See [#]_ See [#]_ Duct location
1239
+ ======================== ======= ============ =========== ======== ========= ===============================
1240
+
1241
+ .. [#] DuctInsulationRValue should not include air films (i.e., use 0 for an uninsulated duct).
1242
+ .. [#] DuctSurfaceArea and DuctLocation are either both required or both disallowed.
1243
+ .. [#] If DuctSurfaceArea not provided, duct areas will be calculated based on `ASHRAE Standard 152 <https://www.energy.gov/eere/buildings/downloads/ashrae-standard-152-spreadsheet>`_:
1244
+
1245
+ - **Primary supply ducts**: 0.27 * F_out * ConditionedFloorAreaServed
1246
+ - **Secondary supply ducts**: 0.27 * (1 - F_out) * ConditionedFloorAreaServed
1247
+ - **Primary return ducts**: b_r * F_out * ConditionedFloorAreaServed
1248
+ - **Secondary return ducts**: b_r * (1 - F_out) * ConditionedFloorAreaServed
1249
+
1250
+ where F_out is 1.0 when NumberofConditionedFloorsAboveGrade <= 1 and 0.75 when NumberofConditionedFloorsAboveGrade > 1, and b_r is 0.05 * NumberofReturnRegisters with a maximum value of 0.25.
1251
+ .. [#] DuctLocation choices are "living space", "basement - conditioned", "basement - unconditioned", "crawlspace - unvented", "crawlspace - vented", "attic - unvented", "attic - vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
1252
+ See :ref:`hpxmllocations` for descriptions.
1253
+ .. [#] DuctLocation and DuctSurfaceArea are either both required or both disallowed.
1254
+ .. [#] If DuctLocation not provided, defaults to the first present space type: "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "attic - vented", "attic - unvented", "garage", or "living space".
1255
+ Any secondary ducts (i.e., when NumberofConditionedFloorsAboveGrade > 1) will always be located in "living space".
1256
+
1257
+ Hydronic Distribution
1258
+ ~~~~~~~~~~~~~~~~~~~~~
1259
+
1260
+ To define a hydronic distribution system, additional information is entered in ``HVACDistribution/DistributionSystemType/HydronicDistribution``.
1261
+
1262
+ ============================ ======= ======= =========== ======== ========= ====================================
1263
+ Element Type Units Constraints Required Default Notes
1264
+ ============================ ======= ======= =========== ======== ========= ====================================
1265
+ ``HydronicDistributionType`` string See [#]_ Yes Type of hydronic distribution system
1266
+ ============================ ======= ======= =========== ======== ========= ====================================
1267
+
1268
+ .. [#] HydronicDistributionType choices are "radiator", "baseboard", "radiant floor", or "radiant ceiling".
1269
+
1270
+ Distribution System Efficiency (DSE)
1271
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1272
+
1273
+ .. warning::
1274
+
1275
+ A simplified DSE model is provided for flexibility, but it is **strongly** recommended to use one of the other detailed distribution system types for better accuracy.
1276
+ Also note that when specifying a DSE system, its effect is reflected in the :ref:`workflow_outputs` but is **not** reflected in the raw EnergyPlus simulation outputs.
1277
+
1278
+ To define a DSE system, additional information is entered in ``HVACDistribution``.
1279
+
1280
+ ============================================= ======= ======= =========== ======== ========= ===================================================
1281
+ Element Type Units Constraints Required Default Notes
1282
+ ============================================= ======= ======= =========== ======== ========= ===================================================
1283
+ ``AnnualHeatingDistributionSystemEfficiency`` double frac 0 - 1 Yes Seasonal distribution system efficiency for heating
1284
+ ``AnnualCoolingDistributionSystemEfficiency`` double frac 0 - 1 Yes Seasonal distribution system efficiency for cooling
1285
+ ============================================= ======= ======= =========== ======== ========= ===================================================
1286
+
1287
+ DSE values can be calculated from `ASHRAE Standard 152 <https://www.energy.gov/eere/buildings/downloads/ashrae-standard-152-spreadsheet>`_.
1288
+
1289
+ HPXML Whole Ventilation Fan
1290
+ ***************************
1291
+
1292
+ Each mechanical ventilation system that provides ventilation to the whole dwelling unit is entered as a ``/HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan``.
1293
+ If not entered, the simulation will not include mechanical ventilation.
1294
+
1295
+ ======================================= ======== ======= =========== ======== ========= =========================================
1296
+ Element Type Units Constraints Required Default Notes
1297
+ ======================================= ======== ======= =========== ======== ========= =========================================
1298
+ ``SystemIdentifier`` id Yes Unique identifier
1299
+ ``UsedForWholeBuildingVentilation`` boolean true Yes Must be set to true
1300
+ ``IsSharedSystem`` boolean See [#]_ No false Whether it serves multiple dwelling units
1301
+ ``FanType`` string See [#]_ Yes Type of ventilation system
1302
+ ``TestedFlowRate`` or ``RatedFlowRate`` double cfm >= 0 Yes Flow rate [#]_
1303
+ ``HoursInOperation`` double hrs/day 0 - 24 No See [#]_ Hours per day of operation
1304
+ ``FanPower`` double W >= 0 Yes Fan power
1305
+ ======================================= ======== ======= =========== ======== ========= =========================================
1306
+
1307
+ .. [#] For central fan integrated supply systems, IsSharedSystem must be false.
1308
+ .. [#] FanType choices are "energy recovery ventilator", "heat recovery ventilator", "exhaust only", "supply only", "balanced", or "central fan integrated supply".
1309
+ .. [#] For a central fan integrated supply system, the flow rate should equal the amount of outdoor air provided to the distribution system.
1310
+ .. [#] 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.
1311
+
1312
+ Exhaust/Supply Only
1313
+ ~~~~~~~~~~~~~~~~~~~
1314
+
1315
+ If a supply only or exhaust only system is specified, no additional information is entered.
1316
+
1317
+ Balanced
1318
+ ~~~~~~~~
1319
+
1320
+ If a balanced system is specified, no additional information is entered.
1321
+
1322
+ Heat Recovery Ventilator
1323
+ ~~~~~~~~~~~~~~~~~~~~~~~~
1324
+
1325
+ If a heat recovery ventilator system is specified, additional information is entered in ``VentilationFan``.
1326
+
1327
+ ======================================================================== ====== ===== =========== ======== ======= =======================================
1328
+ Element Type Units Constraints Required Default Notes
1329
+ ======================================================================== ====== ===== =========== ======== ======= =======================================
1330
+ ``SensibleRecoveryEfficiency`` or ``AdjustedSensibleRecoveryEfficiency`` double frac 0 - 1 Yes (Adjusted) Sensible recovery efficiency
1331
+ ======================================================================== ====== ===== =========== ======== ======= =======================================
1332
+
1333
+ Energy Recovery Ventilator
1334
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~
1335
+
1336
+ If an energy recovery ventilator system is specified, additional information is entered in ``VentilationFan``.
1337
+
1338
+ ======================================================================== ====== ===== =========== ======== ======= =======================================
1339
+ Element Type Units Constraints Required Default Notes
1340
+ ======================================================================== ====== ===== =========== ======== ======= =======================================
1341
+ ``TotalRecoveryEfficiency`` or ``AdjustedTotalRecoveryEfficiency`` double frac 0 - 1 Yes (Adjusted) Total recovery efficiency
1342
+ ``SensibleRecoveryEfficiency`` or ``AdjustedSensibleRecoveryEfficiency`` double frac 0 - 1 Yes (Adjusted) Sensible recovery efficiency
1343
+ ======================================================================== ====== ===== =========== ======== ======= =======================================
1344
+
1345
+ Central Fan Integrated Supply
1346
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1347
+
1348
+ If a central fan integrated supply system is specified, additional information is entered in ``VentilationFan``.
1349
+
1350
+ ==================================== ====== ===== =========== ======== ======= ==================================
1351
+ Element Type Units Constraints Required Default Notes
1352
+ ==================================== ====== ===== =========== ======== ======= ==================================
1353
+ ``AttachedToHVACDistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1354
+ ==================================== ====== ===== =========== ======== ======= ==================================
1355
+
1356
+ .. [#] HVACDistribution type cannot be HydronicDistribution.
1357
+
1358
+ Shared System
1359
+ ~~~~~~~~~~~~~
1360
+
1361
+ If the specified system is a shared system (i.e., serving multiple dwelling units), additional information is entered in ``VentilationFan``.
1362
+
1363
+ ============================ ======= ===== =========== ======== ======= ====================================================
1364
+ Element Type Units Constraints Required Default Notes
1365
+ ============================ ======= ===== =========== ======== ======= ====================================================
1366
+ ``FractionRecirculation`` double frac 0 - 1 Yes Fraction of supply air that is recirculated [#]_
1367
+ ``extension/InUnitFlowRate`` double cfm >= 0 [#]_ Yes Flow rate delivered to the dwelling unit
1368
+ ``extension/PreHeating`` element 0 - 1 No <none> Supply air preconditioned by heating equipment? [#]_
1369
+ ``extension/PreCooling`` element 0 - 1 No <none> Supply air preconditioned by cooling equipment? [#]_
1370
+ ============================ ======= ===== =========== ======== ======= ====================================================
1371
+
1372
+ .. [#] 1-FractionRecirculation is assumed to be the fraction of supply air that is provided from outside.
1373
+ The value must be 0 for exhaust only systems.
1374
+ .. [#] InUnitFlowRate must also be < TestedFlowRate (or RatedFlowRate).
1375
+ .. [#] PreHeating not allowed for exhaust only systems.
1376
+ .. [#] PreCooling not allowed for exhaust only systems.
1377
+
1378
+ If pre-heating is specified, additional information is entered in ``extension/PreHeating``.
1379
+
1380
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1381
+ Element Type Units Constraints Required Default Notes
1382
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1383
+ ``Fuel`` string See [#]_ Yes Pre-heating equipment fuel type
1384
+ ``AnnualHeatingEfficiency[Units="COP"]/Value`` double W/W > 0 Yes Pre-heating equipment annual COP
1385
+ ``FractionVentilationHeatLoadServed`` double frac 0 - 1 Yes Fraction of ventilation heating load served by pre-heating equipment
1386
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1387
+
1388
+ .. [#] Fuel 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".
1389
+
1390
+ If pre-cooling is specified, additional information is entered in ``extension/PreCooling``.
1391
+
1392
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1393
+ Element Type Units Constraints Required Default Notes
1394
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1395
+ ``Fuel`` string See [#]_ Yes Pre-cooling equipment fuel type
1396
+ ``AnnualCoolingEfficiency[Units="COP"]/Value`` double W/W > 0 Yes Pre-cooling equipment annual COP
1397
+ ``FractionVentilationCoolLoadServed`` double frac 0 - 1 Yes Fraction of ventilation cooling load served by pre-cooling equipment
1398
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1399
+
1400
+ .. [#] Fuel only choice is "electricity".
1401
+
1402
+ HPXML Local Ventilation Fan
1403
+ ***************************
1404
+
1405
+ Each kitchen range fan or bathroom fan that provides local ventilation is entered as a ``/HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan``.
1406
+ If not entered, the simulation will not include kitchen/bathroom fans.
1407
+
1408
+ =========================== ======= ======= =========== ======== ======== =============================
1409
+ Element Type Units Constraints Required Default Notes
1410
+ =========================== ======= ======= =========== ======== ======== =============================
1411
+ ``SystemIdentifier`` id Yes Unique identifier
1412
+ ``UsedForLocalVentilation`` boolean true Yes Must be set to true
1413
+ ``Quantity`` integer >= 0 No See [#]_ Number of identical fans
1414
+ ``RatedFlowRate`` double cfm >= 0 No See [#]_ Flow rate
1415
+ ``HoursInOperation`` double hrs/day 0 - 24 No See [#]_ Hours per day of operation
1416
+ ``FanLocation`` string See [#]_ Yes Location of the fan
1417
+ ``FanPower`` double W >= 0 No See [#]_ Fan power
1418
+ ``extension/StartHour`` integer 0 - 23 No See [#]_ Daily start hour of operation
1419
+ =========================== ======= ======= =========== ======== ======== =============================
1420
+
1421
+ .. [#] If Quantity not provided, defaults to 1 for kitchen fans and NumberofBathrooms for bath fans based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1422
+ .. [#] If RatedFlowRate not provided, defaults to 100 cfm for kitchen fans and 50 cfm for bath fans based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1423
+ .. [#] If HoursInOperation not provided, defaults to 1 based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1424
+ .. [#] FanLocation choices are "kitchen" or "bath".
1425
+ .. [#] If FanPower not provided, defaults to 0.3 W/cfm * RatedFlowRate based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1426
+ .. [#] If StartHour not provided, defaults to 18 for kitchen fans and 7 for bath fans based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1427
+
1428
+ HPXML Whole House Fan
1429
+ *********************
1430
+
1431
+ Each whole house fan that provides cooling load reduction is entered as a ``/HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan``.
1432
+ If not entered, the simulation will not include whole house fans.
1433
+
1434
+ ======================================= ======= ======= =========== ======== ======== ==========================
1435
+ Element Type Units Constraints Required Default Notes
1436
+ ======================================= ======= ======= =========== ======== ======== ==========================
1437
+ ``SystemIdentifier`` id Yes Unique identifier
1438
+ ``UsedForSeasonalCoolingLoadReduction`` boolean true Yes Must be set to true
1439
+ ``RatedFlowRate`` double cfm >= 0 Yes Flow rate
1440
+ ``FanPower`` double W >= 0 Yes Fan power
1441
+ ======================================= ======= ======= =========== ======== ======== ==========================
1442
+
1443
+ .. note::
1444
+
1445
+ The whole house fan is assumed to operate during hours of favorable outdoor conditions and will take priority over operable windows (natural ventilation).
1446
+
1447
+ HPXML Water Heating Systems
1448
+ ***************************
1449
+
1450
+ Each water heater is entered as a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/WaterHeatingSystem``.
1451
+ If not entered, the simulation will not include water heating.
1452
+
1453
+ ========================= ======= ======= =========== ======== ======== ================================================================
1454
+ Element Type Units Constraints Required Default Notes
1455
+ ========================= ======= ======= =========== ======== ======== ================================================================
1456
+ ``SystemIdentifier`` id Yes Unique identifier
1457
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units or shared laundry room
1458
+ ``WaterHeaterType`` string See [#]_ Yes Type of water heater
1459
+ ``Location`` string See [#]_ No See [#]_ Water heater location
1460
+ ``FractionDHWLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of hot water load served [#]_
1461
+ ``HotWaterTemperature`` double F > 0 No 125 Water heater setpoint
1462
+ ``UsesDesuperheater`` boolean No false Presence of desuperheater?
1463
+ ``NumberofUnitsServed`` integer > 0 See [#]_ Number of dwelling units served directly or indirectly
1464
+ ========================= ======= ======= =========== ======== ======== ================================================================
1465
+
1466
+ .. [#] WaterHeaterType choices are "storage water heater", "instantaneous water heater", "heat pump water heater", "space-heating boiler with storage tank", or "space-heating boiler with tankless coil".
1467
+ .. [#] Location choices are "living space", "basement - unconditioned", "basement - conditioned", "attic - unvented", "attic - vented", "garage", "crawlspace - unvented", "crawlspace - vented", "other exterior", "other housing unit", "other heated space", "other multifamily buffer space", or "other non-freezing space".
1468
+ See :ref:`hpxmllocations` for descriptions.
1469
+ .. [#] If Location not provided, defaults to the first present space type:
1470
+
1471
+ - **IECC zones 1-3, excluding 3A**: "garage", "living space"
1472
+ - **IECC zones 3A, 4-8, unknown**: "basement - conditioned", "basement - unconditioned", "living space"
1473
+
1474
+ .. [#] The sum of all ``FractionDHWLoadServed`` (across all WaterHeatingSystems) must equal to 1.
1475
+ .. [#] FractionDHWLoadServed represents only the fraction of the hot water load associated with the hot water **fixtures**.
1476
+ Additional hot water load from clothes washers/dishwashers will be automatically assigned to the appropriate water heater(s).
1477
+ .. [#] NumberofUnitsServed only required if IsSharedSystem is true, in which case it must be > 1.
1478
+
1479
+ Conventional Storage
1480
+ ~~~~~~~~~~~~~~~~~~~~
1481
+
1482
+ If a conventional storage water heater is specified, additional information is entered in ``WaterHeatingSystem``.
1483
+
1484
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1485
+ Element Type Units Constraints Required Default Notes
1486
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1487
+ ``FuelType`` string See [#]_ Yes Fuel type
1488
+ ``TankVolume`` double gal > 0 No See [#]_ Tank volume
1489
+ ``HeatingCapacity`` double Btuh > 0 No See [#]_ Heating capacity
1490
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac < 1 Yes EnergyGuide label rated efficiency
1491
+ ``FirstHourRating`` double gal/hr > 0 See [#]_ EnergyGuide label first hour rating
1492
+ ``RecoveryEfficiency`` double frac 0 - 1 No See [#]_ Recovery efficiency
1493
+ ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional tank insulation wrap
1494
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1495
+
1496
+ .. [#] 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".
1497
+ .. [#] 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>`_.
1498
+ .. [#] 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>`_.
1499
+ .. [#] FirstHourRating only required if UniformEnergyFactor provided.
1500
+ .. [#] If RecoveryEfficiency not provided, defaults as follows based on a regression analysis of `AHRI certified water heaters <https://www.ahridirectory.org/NewSearch?programId=24&searchTypeId=3>`_:
1501
+
1502
+ - **Electric**: 0.98
1503
+ - **Non-electric, EnergyFactor < 0.75**: 0.252 * EnergyFactor + 0.608
1504
+ - **Non-electric, EnergyFactor >= 0.75**: 0.561 * EnergyFactor + 0.439
1505
+
1506
+ Tankless
1507
+ ~~~~~~~~
1508
+
1509
+ If an instantaneous tankless water heater is specified, additional information is entered in ``WaterHeatingSystem``.
1510
+
1511
+ =========================================== ======= ============ =========== ============ ======== ==========================================================
1512
+ Element Type Units Constraints Required Default Notes
1513
+ =========================================== ======= ============ =========== ============ ======== ==========================================================
1514
+ ``FuelType`` string See [#]_ Yes Fuel type
1515
+ ``PerformanceAdjustment`` double frac No See [#]_ Multiplier on efficiency, typically to account for cycling
1516
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac < 1 Yes EnergyGuide label rated efficiency
1517
+ =========================================== ======= ============ =========== ============ ======== ==========================================================
1518
+
1519
+ .. [#] 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".
1520
+ .. [#] If PerformanceAdjustment not provided, defaults to 0.94 (UEF) or 0.92 (EF) based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
1521
+
1522
+ Heat Pump
1523
+ ~~~~~~~~~
1524
+
1525
+ If a heat pump water heater is specified, additional information is entered in ``WaterHeatingSystem``.
1526
+
1527
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1528
+ Element Type Units Constraints Required Default Notes
1529
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1530
+ ``FuelType`` string See [#]_ Yes Fuel type
1531
+ ``TankVolume`` double gal > 0 Yes Tank volume
1532
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac > 1 Yes EnergyGuide label rated efficiency
1533
+ ``FirstHourRating`` double gal/hr > 0 See [#]_ EnergyGuide label first hour rating
1534
+ ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional tank insulation wrap
1535
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1536
+
1537
+ .. [#] FuelType only choice is "electricity".
1538
+ .. [#] FirstHourRating only required if UniformEnergyFactor provided.
1539
+
1540
+ Combi Boiler w/ Storage
1541
+ ~~~~~~~~~~~~~~~~~~~~~~~
1542
+
1543
+ If a combination boiler w/ storage tank (sometimes referred to as an indirect water heater) is specified, additional information is entered in ``WaterHeatingSystem``.
1544
+
1545
+ ============================================= ======= ============ =========== ============ ======== ==================================================
1546
+ Element Type Units Constraints Required Default Notes
1547
+ ============================================= ======= ============ =========== ============ ======== ==================================================
1548
+ ``RelatedHVACSystem`` idref See [#]_ Yes ID of boiler
1549
+ ``TankVolume`` double gal > 0 Yes Volume of the storage tank
1550
+ ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional storage tank insulation wrap
1551
+ ``StandbyLoss`` double F/hr > 0 No See [#]_ Storage tank standby losses
1552
+ ============================================= ======= ============ =========== ============ ======== ==================================================
1553
+
1554
+ .. [#] RelatedHVACSystem must reference a ``HeatingSystem`` of type Boiler.
1555
+ .. [#] If StandbyLoss not provided, defaults based on a regression analysis of `AHRI Directory of Certified Product Performance <https://www.ahridirectory.org>`_.
1556
+
1557
+ Combi Boiler w/ Tankless Coil
1558
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1559
+
1560
+ If a combination boiler w/ tankless coil is specified, additional information is entered in ``WaterHeatingSystem``.
1561
+
1562
+ ===================== ======= ============ =========== ============ ======== ==================================================
1563
+ Element Type Units Constraints Required Default Notes
1564
+ ===================== ======= ============ =========== ============ ======== ==================================================
1565
+ ``RelatedHVACSystem`` idref See [#]_ Yes ID of boiler
1566
+ ===================== ======= ============ =========== ============ ======== ==================================================
1567
+
1568
+ .. [#] RelatedHVACSystem must reference a ``HeatingSystem`` (Boiler).
1569
+
1570
+ Desuperheater
1571
+ ~~~~~~~~~~~~~
1572
+
1573
+ If the water heater uses a desuperheater, additional information is entered in ``WaterHeatingSystem``.
1574
+
1575
+ ===================== ======= ============ =========== ============ ======== ==================================
1576
+ Element Type Units Constraints Required Default Notes
1577
+ ===================== ======= ============ =========== ============ ======== ==================================
1578
+ ``RelatedHVACSystem`` idref See [#]_ Yes ID of heat pump or air conditioner
1579
+ ===================== ======= ============ =========== ============ ======== ==================================
1580
+
1581
+ .. [#] RelatedHVACSystem must reference a ``HeatPump`` (air-to-air, mini-split, or ground-to-air) or ``CoolingSystem`` (central air conditioner or mini-split).
1582
+
1583
+ HPXML Hot Water Distribution
1584
+ ****************************
1585
+
1586
+ If any water heating systems are provided, a single hot water distribution system is entered as a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/HotWaterDistribution``.
1587
+
1588
+ ================================= ======= ============ =========== ======== ======== =======================================================================
1589
+ Element Type Units Constraints Required Default Notes
1590
+ ================================= ======= ============ =========== ======== ======== =======================================================================
1591
+ ``SystemIdentifier`` id Yes Unique identifier
1592
+ ``SystemType`` element 1 [#]_ Yes Type of in-unit distribution system serving the dwelling unit
1593
+ ``PipeInsulation/PipeRValue`` double F-ft2-hr/Btu >= 0 No 0.0 Pipe insulation R-value
1594
+ ``DrainWaterHeatRecovery`` element 0 - 1 No <none> Presence of drain water heat recovery device
1595
+ ``extension/SharedRecirculation`` element 0 - 1 [#]_ No <none> Presence of shared recirculation system serving multiple dwelling units
1596
+ ================================= ======= ============ =========== ======== ======== =======================================================================
1597
+
1598
+ .. [#] SystemType child element choices are ``Standard`` and ``Recirculation``.
1599
+ .. [#] If SharedRecirculation is provided, SystemType must be ``Standard``.
1600
+ This is because a stacked recirculation system (i.e., shared recirculation loop plus an additional in-unit recirculation system) is more likely to indicate input errors than reflect an actual real-world scenario.
1601
+
1602
+ .. note::
1603
+
1604
+ In attached/multifamily buildings, only the hot water distribution system serving the dwelling unit should be defined.
1605
+ The hot water distribution associated with, e.g., a shared laundry room should not be defined.
1606
+
1607
+ Standard
1608
+ ~~~~~~~~
1609
+
1610
+ If the in-unit distribution system is specified as standard, additional information is entered in ``SystemType/Standard``.
1611
+
1612
+ ================ ======= ===== =========== ======== ======== =====================
1613
+ Element Type Units Constraints Required Default Notes
1614
+ ================ ======= ===== =========== ======== ======== =====================
1615
+ ``PipingLength`` double ft > 0 No See [#]_ Length of piping [#]_
1616
+ ================ ======= ===== =========== ======== ======== =====================
1617
+
1618
+ .. [#] | If PipingLength not provided, calculated using the following equation from `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_:
1619
+ | PipeL = 2.0 * (CFA / NCfl)^0.5 + 10.0 * NCfl + 5.0 * Bsmnt
1620
+ | where
1621
+ | CFA = conditioned floor area [ft2],
1622
+ | NCfl = number of conditioned floor levels number of conditioned floor levels in the residence including conditioned basements,
1623
+ | Bsmnt = presence (1.0) or absence (0.0) of an unconditioned basement in the residence.
1624
+ .. [#] PipingLength is the length of hot water piping from the hot water heater (or from a shared recirculation loop serving multiple dwelling units) to the farthest hot water fixture, measured longitudinally from plans, assuming the hot water piping does not run diagonally, plus 10 feet of piping for each floor level, plus 5 feet of piping for unconditioned basements (if any).
1625
+
1626
+ Recirculation
1627
+ ~~~~~~~~~~~~~
1628
+
1629
+ If the in-unit distribution system is specified as recirculation, additional information is entered in ``SystemType/Recirculation``.
1630
+
1631
+ ================================= ======= ===== =========== ======== ======== =====================================
1632
+ Element Type Units Constraints Required Default Notes
1633
+ ================================= ======= ===== =========== ======== ======== =====================================
1634
+ ``ControlType`` string See [#]_ Yes Recirculation control type
1635
+ ``RecirculationPipingLoopLength`` double ft > 0 No See [#]_ Recirculation piping loop length [#]_
1636
+ ``BranchPipingLoopLength`` double ft > 0 No 10 Branch piping loop length [#]_
1637
+ ``PumpPower`` double W >= 0 No 50 [#]_ Recirculation pump power
1638
+ ================================= ======= ===== =========== ======== ======== =====================================
1639
+
1640
+ .. [#] ControlType choices are "manual demand control", "presence sensor demand control", "temperature", "timer", or "no control".
1641
+ .. [#] | If RecirculationPipingLoopLength not provided, calculated using the following equation from `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_:
1642
+ | RecircPipeL = 2.0 * (2.0 * (CFA / NCfl)^0.5 + 10.0 * NCfl + 5.0 * Bsmnt) - 20.0
1643
+ | where
1644
+ | CFA = conditioned floor area [ft2],
1645
+ | NCfl = number of conditioned floor levels number of conditioned floor levels in the residence including conditioned basements,
1646
+ | Bsmnt = presence (1.0) or absence (0.0) of an unconditioned basement in the residence.
1647
+ .. [#] 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.
1648
+ .. [#] 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.
1649
+ .. [#] PumpPower default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
1650
+
1651
+ Shared Recirculation
1652
+ ~~~~~~~~~~~~~~~~~~~~
1653
+
1654
+ If a shared recirculation system is specified, additional information is entered in ``extension/SharedRecirculation``.
1655
+
1656
+ ======================= ======= ===== =========== ======== ======== =================================
1657
+ Element Type Units Constraints Required Default Notes
1658
+ ======================= ======= ===== =========== ======== ======== =================================
1659
+ ``NumberofUnitsServed`` integer > 1 Yes Number of dwelling units served
1660
+ ``PumpPower`` double W >= 0 No 220 [#]_ Shared recirculation pump power
1661
+ ``ControlType`` string See [#]_ Yes Shared recirculation control type
1662
+ ======================= ======= ===== =========== ======== ======== =================================
1663
+
1664
+ .. [#] PumpPower default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
1665
+ .. [#] ControlType choices are "manual demand control", "presence sensor demand control", "timer", or "no control".
1666
+
1667
+ Drain Water Heat Recovery
1668
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
1669
+
1670
+ If a drain water heat recovery (DWHR) device is specified, additional information is entered in ``DrainWaterHeatRecovery``.
1671
+
1672
+ ======================= ======= ===== =========== ======== ======== =========================================
1673
+ Element Type Units Constraints Required Default Notes
1674
+ ======================= ======= ===== =========== ======== ======== =========================================
1675
+ ``FacilitiesConnected`` string See [#]_ Yes Specifies which facilities are connected
1676
+ ``EqualFlow`` boolean Yes Specifies how the DHWR is configured [#]_
1677
+ ``Efficiency`` double frac 0 - 1 Yes Efficiency according to CSA 55.1
1678
+ ======================= ======= ===== =========== ======== ======== =========================================
1679
+
1680
+ .. [#] FacilitiesConnected choices are "one" or "all".
1681
+ Use "one" if there are multiple showers and only one of them is connected to the DWHR.
1682
+ Use "all" if there is one shower and it's connected to the DWHR or there are two or more showers connected to the DWHR.
1683
+ .. [#] EqualFlow should be true if the DWHR supplies pre-heated water to both the fixture cold water piping *and* the hot water heater potable supply piping.
1684
+
1685
+ HPXML Water Fixtures
1686
+ ********************
1687
+
1688
+ Each water fixture is entered as a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/WaterFixture``.
1689
+
1690
+ ==================== ======= ===== =========== ======== ======== ===============================================
1691
+ Element Type Units Constraints Required Default Notes
1692
+ ==================== ======= ===== =========== ======== ======== ===============================================
1693
+ ``SystemIdentifier`` id Yes Unique identifier
1694
+ ``WaterFixtureType`` string See [#]_ Yes Type of water fixture
1695
+ ``LowFlow`` boolean Yes Whether the fixture is considered low-flow [#]_
1696
+ ==================== ======= ===== =========== ======== ======== ===============================================
1697
+
1698
+ .. [#] WaterFixtureType choices are "shower head" or "faucet".
1699
+ .. [#] LowFlow should be true if the fixture's flow rate (gpm) is <= 2.0.
1700
+
1701
+ In addition, a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/extension/WaterFixturesUsageMultiplier`` can be optionally provided that scales hot water usage.
1702
+ if not provided, it is assumed to be 1.0.
1703
+
1704
+ HPXML Solar Thermal
1705
+ *******************
1706
+
1707
+ A single solar hot water system can be entered as a ``/HPXML/Building/BuildingDetails/Systems/SolarThermal/SolarThermalSystem``.
1708
+ If not entered, the simulation will not include solar hot water.
1709
+
1710
+ ==================== ======= ===== =========== ======== ======== ============================
1711
+ Element Type Units Constraints Required Default Notes
1712
+ ==================== ======= ===== =========== ======== ======== ============================
1713
+ ``SystemIdentifier`` id Yes Unique identifier
1714
+ ``SystemType`` string See [#]_ Yes Type of solar thermal system
1715
+ ==================== ======= ===== =========== ======== ======== ============================
1716
+
1717
+ .. [#] SystemType only choice is "hot water".
1718
+
1719
+ Solar hot water systems can be described with either simple or detailed inputs.
1720
+
1721
+ Simple Inputs
1722
+ ~~~~~~~~~~~~~
1723
+
1724
+ To define a simple solar hot water system, additional information is entered in ``SolarThermalSystem``.
1725
+
1726
+ ================= ======= ===== =========== ======== ======== ======================
1727
+ Element Type Units Constraints Required Default Notes
1728
+ ================= ======= ===== =========== ======== ======== ======================
1729
+ ``SolarFraction`` double frac 0 - 1 Yes Solar fraction [#]_
1730
+ ``ConnectedTo`` idref See [#]_ No [#]_ <none> Connected water heater
1731
+ ================= ======= ===== =========== ======== ======== ======================
1732
+
1733
+ .. [#] Portion of total conventional hot water heating load (delivered energy plus tank standby losses).
1734
+ Can be obtained from `Directory of SRCC OG-300 Solar Water Heating System Ratings <https://solar-rating.org/programs/og-300-program/>`_ or NREL's `System Advisor Model <https://sam.nrel.gov/>`_ or equivalent.
1735
+ .. [#] ConnectedTo must reference a ``WaterHeatingSystem``.
1736
+ The referenced water heater cannot be a space-heating boiler nor attached to a desuperheater.
1737
+ .. [#] If ConnectedTo not provided, solar fraction will apply to all water heaters in the building.
1738
+
1739
+ Detailed Inputs
1740
+ ~~~~~~~~~~~~~~~
1741
+
1742
+ To define a detailed solar hot water system, additional information is entered in ``SolarThermalSystem``.
1743
+
1744
+ =================================== ======= ============ =========== ======== ======== ==============================
1745
+ Element Type Units Constraints Required Default Notes
1746
+ =================================== ======= ============ =========== ======== ======== ==============================
1747
+ ``CollectorArea`` double ft2 > 0 Yes Area
1748
+ ``CollectorLoopType`` string See [#]_ Yes Loop type
1749
+ ``CollectorType`` string See [#]_ Yes System type
1750
+ ``CollectorAzimuth`` integer deg 0 - 359 Yes Azimuth (clockwise from North)
1751
+ ``CollectorTilt`` double deg 0 - 90 Yes Tilt relative to horizontal
1752
+ ``CollectorRatedOpticalEfficiency`` double frac 0 - 1 Yes Rated optical efficiency [#]_
1753
+ ``CollectorRatedThermalLosses`` double Btu/hr-ft2-R > 0 Yes Rated thermal losses [#]_
1754
+ ``StorageVolume`` double gal > 0 No See [#]_ Hot water storage volume
1755
+ ``ConnectedTo`` idref See [#]_ Yes Connected water heater
1756
+ =================================== ======= ============ =========== ======== ======== ==============================
1757
+
1758
+ .. [#] CollectorLoopType choices are "liquid indirect", "liquid direct", or "passive thermosyphon".
1759
+ .. [#] CollectorType choices are "single glazing black", "double glazing black", "evacuated tube", or "integrated collector storage".
1760
+ .. [#] CollectorRatedOpticalEfficiency is FRTA (y-intercept) from the `Directory of SRCC OG-100 Certified Solar Collector Ratings <https://solar-rating.org/programs/og-100-program/>`_.
1761
+ .. [#] CollectorRatedThermalLosses is FRUL (slope) from the `Directory of SRCC OG-100 Certified Solar Collector Ratings <https://solar-rating.org/programs/og-100-program/>`_.
1762
+ .. [#] If StorageVolume not provided, calculated as 1.5 gal/ft2 * CollectorArea.
1763
+ .. [#] ConnectedTo must reference a ``WaterHeatingSystem`` that is not of type space-heating boiler nor connected to a desuperheater.
1764
+
1765
+ HPXML Photovoltaics
1766
+ *******************
1767
+
1768
+ Each solar electric photovoltaic (PV) system is entered as a ``/HPXML/Building/BuildingDetails/Systems/Photovoltaics/PVSystem``.
1769
+ If not entered, the simulation will not include photovoltaics.
1770
+
1771
+ Many of the inputs are adopted from the `PVWatts model <https://pvwatts.nrel.gov>`_.
1772
+
1773
+ ======================================================= ================= ========= =============== ======== ======== ============================================
1774
+ Element Type Units Constraints Required Default Notes
1775
+ ======================================================= ================= ========= =============== ======== ======== ============================================
1776
+ ``SystemIdentifier`` id Yes Unique identifier
1777
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
1778
+ ``Location`` string See [#]_ No roof Mounting location
1779
+ ``ModuleType`` string See [#]_ No standard Type of module
1780
+ ``Tracking`` string See [#]_ No fixed Type of tracking
1781
+ ``ArrayAzimuth`` integer deg 0 - 359 Yes Direction panels face (clockwise from North)
1782
+ ``ArrayTilt`` double deg 0 - 90 Yes Tilt relative to horizontal
1783
+ ``MaxPowerOutput`` double W >= 0 Yes Peak power
1784
+ ``InverterEfficiency`` double frac 0 - 1 No 0.96 Inverter efficiency
1785
+ ``SystemLossesFraction`` or ``YearModulesManufactured`` double or integer frac or # 0 - 1 or > 1600 No 0.14 System losses [#]_
1786
+ ``extension/NumberofBedroomsServed`` integer > 1 See [#]_ Number of bedrooms served
1787
+ ======================================================= ================= ========= =============== ======== ======== ============================================
1788
+
1789
+ .. [#] Location choices are "ground" or "roof" mounted.
1790
+ .. [#] ModuleType choices are "standard", "premium", or "thin film".
1791
+ .. [#] Tracking choices are "fixed", "1-axis", "1-axis backtracked", or "2-axis".
1792
+ .. [#] System losses due to soiling, shading, snow, mismatch, wiring, degradation, etc.
1793
+ If YearModulesManufactured provided but not SystemLossesFraction, system losses calculated as:
1794
+ SystemLossesFraction = 1.0 - (1.0 - 0.14) * (1.0 - (1.0 - 0.995^(CurrentYear - YearModulesManufactured))).
1795
+ .. [#] NumberofBedroomsServed only required if IsSharedSystem is true, in which case it must be > NumberofBedrooms.
1796
+ PV generation will be apportioned to the dwelling unit using its number of bedrooms divided by the total number of bedrooms served by the PV system.
1797
+
1798
+ HPXML Generators
1799
+ ****************
1800
+
1801
+ Each generator that provides on-site power is entered as a ``/HPXML/Building/BuildingDetails/Systems/extension/Generators/Generator``.
1802
+ If not entered, the simulation will not include generators.
1803
+
1804
+ ========================== ======= ======= =========== ======== ======= ============================================
1805
+ Element Type Units Constraints Required Default Notes
1806
+ ========================== ======= ======= =========== ======== ======= ============================================
1807
+ ``SystemIdentifier`` id Yes Unique identifier
1808
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
1809
+ ``FuelType`` string See [#]_ Yes Fuel type
1810
+ ``AnnualConsumptionkBtu`` double kBtu/yr > 0 Yes Annual fuel consumed
1811
+ ``AnnualOutputkWh`` double kWh/yr > 0 [#]_ Yes Annual electricity produced
1812
+ ``NumberofBedroomsServed`` integer > 1 See [#]_ Number of bedrooms served
1813
+ ========================== ======= ======= =========== ======== ======= ============================================
1814
+
1815
+ .. [#] 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", "wood", or "wood pellets".
1816
+ .. [#] AnnualOutputkWh must also be < AnnualConsumptionkBtu*3.412 (i.e., the generator must consume more energy than it produces).
1817
+ .. [#] NumberofBedroomsServed only required if IsSharedSystem is true, in which case it must be > NumberofBedrooms.
1818
+ Annual consumption and annual production will be apportioned to the dwelling unit using its number of bedrooms divided by the total number of bedrooms served by the generator.
1819
+
1820
+ .. note::
1821
+
1822
+ Generators will be modeled as operating continuously (24/7).
1823
+
1824
+ HPXML Appliances
1825
+ ----------------
1826
+
1827
+ Appliances entered in ``/HPXML/Building/BuildingDetails/Appliances``.
1828
+
1829
+ HPXML Clothes Washer
1830
+ ********************
1831
+
1832
+ A single clothes washer can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/ClothesWasher``.
1833
+ If not entered, the simulation will not include a clothes washer.
1834
+
1835
+ ============================================================== ======= =========== =========== ======== ============ ==============================================
1836
+ Element Type Units Constraints Required Default Notes
1837
+ ============================================================== ======= =========== =========== ======== ============ ==============================================
1838
+ ``SystemIdentifier`` id Yes Unique identifier
1839
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
1840
+ ``Location`` string See [#]_ No living space Location
1841
+ ``IntegratedModifiedEnergyFactor`` or ``ModifiedEnergyFactor`` double ft3/kWh/cyc > 0 No See [#]_ EnergyGuide label efficiency [#]_
1842
+ ``AttachedToWaterHeatingSystem`` idref See [#]_ See [#]_ ID of attached water heater
1843
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
1844
+ ============================================================== ======= =========== =========== ======== ============ ==============================================
1845
+
1846
+ .. [#] For example, a clothes washer in a shared laundry room of a MF building.
1847
+ .. [#] 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".
1848
+ See :ref:`hpxmllocations` for descriptions.
1849
+ .. [#] If neither IntegratedModifiedEnergyFactor nor ModifiedEnergyFactor provided, the following default values representing a standard clothes washer from 2006 will be used:
1850
+ IntegratedModifiedEnergyFactor = 1.0,
1851
+ RatedAnnualkWh = 400,
1852
+ LabelElectricRate = 0.12,
1853
+ LabelGasRate = 1.09,
1854
+ LabelAnnualGasCost = 27.0,
1855
+ LabelUsage = 6,
1856
+ Capacity = 3.0.
1857
+ .. [#] 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>`_:
1858
+ IMEF = (MEF - 0.503) / 0.95.
1859
+ .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``.
1860
+ .. [#] AttachedToWaterHeatingSystem only required if IsSharedAppliance is true.
1861
+
1862
+ If IntegratedModifiedEnergyFactor or ModifiedEnergyFactor is provided, a complete set of EnergyGuide label information is entered in ``ClothesWasher``.
1863
+
1864
+ ================================ ======= ======= =========== ============ ======= ====================================
1865
+ Element Type Units Constraints Required Default Notes
1866
+ ================================ ======= ======= =========== ============ ======= ====================================
1867
+ ``RatedAnnualkWh`` double kWh/yr > 0 Yes EnergyGuide label annual consumption
1868
+ ``LabelElectricRate`` double $/kWh > 0 Yes EnergyGuide label electricity rate
1869
+ ``LabelGasRate`` double $/therm > 0 Yes EnergyGuide label natural gas rate
1870
+ ``LabelAnnualGasCost`` double $ > 0 Yes EnergyGuide label annual gas cost
1871
+ ``LabelUsage`` double cyc/wk > 0 Yes EnergyGuide label number of cycles
1872
+ ``Capacity`` double ft3 > 0 Yes Clothes dryer volume
1873
+ ================================ ======= ======= =========== ============ ======= ====================================
1874
+
1875
+ 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>`_.
1876
+
1877
+ HPXML Clothes Dryer
1878
+ *******************
1879
+
1880
+ A single clothes dryer can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/ClothesDryer``.
1881
+ If not entered, the simulation will not include a clothes dryer.
1882
+
1883
+ ============================================ ======= ====== =========== ======== ============ ==============================================
1884
+ Element Type Units Constraints Required Default Notes
1885
+ ============================================ ======= ====== =========== ======== ============ ==============================================
1886
+ ``SystemIdentifier`` id Yes Unique identifier
1887
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
1888
+ ``Location`` string See [#]_ No living space Location
1889
+ ``FuelType`` string See [#]_ Yes Fuel type
1890
+ ``CombinedEnergyFactor`` or ``EnergyFactor`` double lb/kWh > 0 No See [#]_ EnergyGuide label efficiency [#]_
1891
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
1892
+ ``extension/IsVented`` boolean No true Whether dryer is vented
1893
+ ``extension/VentedFlowRate`` double cfm >= 0 See [#]_ 100 [#]_ Exhust flow rate during operation
1894
+ ============================================ ======= ====== =========== ======== ============ ==============================================
1895
+
1896
+ .. [#] For example, a clothes dryer in a shared laundry room of a MF building.
1897
+ .. [#] 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".
1898
+ See :ref:`hpxmllocations` for descriptions.
1899
+ .. [#] 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".
1900
+ .. [#] If neither CombinedEnergyFactor nor EnergyFactor provided, the following default values representing a standard clothes dryer from 2006 will be used:
1901
+ CombinedEnergyFactor = 3.01.
1902
+ .. [#] 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>`_:
1903
+ CEF = EF / 1.15.
1904
+ .. [#] VentedFlowRate only required if IsVented is true.
1905
+ .. [#] VentedFlowRate default based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1906
+
1907
+ Clothes dryer energy 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>`_.
1908
+
1909
+ HPXML Dishwasher
1910
+ ****************
1911
+
1912
+ A single dishwasher can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Dishwasher``.
1913
+ If not entered, the simulation will not include a dishwasher.
1914
+
1915
+ ============================================ ======= =========== =========== ======== ============ ==============================================
1916
+ Element Type Units Constraints Required Default Notes
1917
+ ============================================ ======= =========== =========== ======== ============ ==============================================
1918
+ ``SystemIdentifier`` id Yes Unique identifier
1919
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
1920
+ ``Location`` string See [#]_ No living space Location
1921
+ ``RatedAnnualkWh`` or ``EnergyFactor`` double kWh/yr or # > 0 No See [#]_ EnergyGuide label consumption/efficiency [#]_
1922
+ ``AttachedToWaterHeatingSystem`` idref See [#]_ See [#]_ ID of attached water heater
1923
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
1924
+ ============================================ ======= =========== =========== ======== ============ ==============================================
1925
+
1926
+ .. [#] For example, a dishwasher in a shared mechanical room of a MF building.
1927
+ .. [#] 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".
1928
+ See :ref:`hpxmllocations` for descriptions.
1929
+ .. [#] If neither RatedAnnualkWh nor EnergyFactor provided, the following default values representing a standard dishwasher from 2006 will be used:
1930
+ RatedAnnualkWh = 467,
1931
+ LabelElectricRate = 0.12,
1932
+ LabelGasRate = 1.09,
1933
+ LabelAnnualGasCost = 33.12,
1934
+ LabelUsage = 4,
1935
+ PlaceSettingCapacity = 12.
1936
+ .. [#] 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>`_:
1937
+ RatedAnnualkWh = 215.0 / EF.
1938
+ .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``.
1939
+ .. [#] AttachedToWaterHeatingSystem only required if IsSharedAppliance is true.
1940
+
1941
+ If the RatedAnnualkWh or EnergyFactor is provided, a complete set of EnergyGuide label information is entered in ``Dishwasher``.
1942
+
1943
+ ======================== ======= ======= =========== ======== ======= ==================================
1944
+ Element Type Units Constraints Required Default Notes
1945
+ ======================== ======= ======= =========== ======== ======= ==================================
1946
+ ``LabelElectricRate`` double $/kWh > 0 Yes EnergyGuide label electricity rate
1947
+ ``LabelGasRate`` double $/therm > 0 Yes EnergyGuide label natural gas rate
1948
+ ``LabelAnnualGasCost`` double $ > 0 Yes EnergyGuide label annual gas cost
1949
+ ``LabelUsage`` double cyc/wk > 0 Yes EnergyGuide label number of cycles
1950
+ ``PlaceSettingCapacity`` integer # > 0 Yes Number of place settings
1951
+ ======================== ======= ======= =========== ======== ======= ==================================
1952
+
1953
+ Dishwasher 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>`_.
1954
+
1955
+ HPXML Refrigerators
1956
+ *******************
1957
+
1958
+ Each refrigerator can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Refrigerator``.
1959
+ If not entered, the simulation will not include a refrigerator.
1960
+
1961
+ ===================================================== ======= ====== =========== ======== ======== ======================================
1962
+ Element Type Units Constraints Required Default Notes
1963
+ ===================================================== ======= ====== =========== ======== ======== ======================================
1964
+ ``SystemIdentifier`` id Yes Unique identifier
1965
+ ``Location`` string See [#]_ No See [#]_ Location
1966
+ ``RatedAnnualkWh`` or ``extension/AdjustedAnnualkWh`` double kWh/yr > 0 No See [#]_ Annual consumption
1967
+ ``PrimaryIndicator`` boolean See [#]_ Primary refrigerator?
1968
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
1969
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
1970
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
1971
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
1972
+ ===================================================== ======= ====== =========== ======== ======== ======================================
1973
+
1974
+ .. [#] 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".
1975
+ See :ref:`hpxmllocations` for descriptions.
1976
+ .. [#] If Location not provided and is the *primary* refrigerator, defaults to "living space".
1977
+ If Location not provided and is a *secondary* refrigerator, defaults to the first present space type: "garage", "basement - unconditioned", "basement - conditioned", or "living space".
1978
+ .. [#] If neither RatedAnnualkWh nor AdjustedAnnualkWh provided, it will be defaulted to represent a standard refrigerator from 2006 using the following equation based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_:
1979
+ RatedAnnualkWh = 637.0 + 18.0 * NumberofBedrooms.
1980
+ .. [#] If multiple refrigerators are specified, there must be exactly one refrigerator described with PrimaryIndicator=true.
1981
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 16 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.040, 0.039, 0.038, 0.037, 0.036, 0.036, 0.038, 0.040, 0.041, 0.041, 0.040, 0.040, 0.042, 0.042, 0.042, 0.041, 0.044, 0.048, 0.050, 0.048, 0.047, 0.046, 0.044, 0.041".
1982
+ .. [#] If MonthlyScheduleMultipliers not provided, default values from Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.837, 0.835, 1.084, 1.084, 1.084, 1.096, 1.096, 1.096, 1.096, 0.931, 0.925, 0.837".
1983
+
1984
+ HPXML Freezers
1985
+ **************
1986
+
1987
+ Each standalone freezer can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Freezer``.
1988
+ If not entered, the simulation will not include a standalone freezer.
1989
+
1990
+ ===================================================== ====== ====== =========== ======== ========== ======================================
1991
+ Element Type Units Constraints Required Default Notes
1992
+ ===================================================== ====== ====== =========== ======== ========== ======================================
1993
+ ``SystemIdentifier`` id Yes Unique identifier
1994
+ ``Location`` string See [#]_ No See [#]_ Location
1995
+ ``RatedAnnualkWh`` or ``extension/AdjustedAnnualkWh`` double kWh/yr > 0 No 319.8 [#]_ Annual consumption
1996
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
1997
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
1998
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
1999
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2000
+ ===================================================== ====== ====== =========== ======== ========== ======================================
2001
+
2002
+ .. [#] 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".
2003
+ See :ref:`hpxmllocations` for descriptions.
2004
+ .. [#] If Location not provided, defaults to "garage" if present, otherwise "basement - unconditioned" if present, otherwise "basement - conditioned" if present, otherwise "living space".
2005
+ .. [#] RatedAnnualkWh default based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
2006
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 16 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.040, 0.039, 0.038, 0.037, 0.036, 0.036, 0.038, 0.040, 0.041, 0.041, 0.040, 0.040, 0.042, 0.042, 0.042, 0.041, 0.044, 0.048, 0.050, 0.048, 0.047, 0.046, 0.044, 0.041".
2007
+ .. [#] If MonthlyScheduleMultipliers not provided, default values from Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.837, 0.835, 1.084, 1.084, 1.084, 1.096, 1.096, 1.096, 1.096, 0.931, 0.925, 0.837".
2008
+
2009
+ HPXML Dehumidifier
2010
+ ******************
2011
+
2012
+ Each dehumidifier can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Dehumidifier``.
2013
+ If not entered, the simulation will not include a dehumidifier.
2014
+
2015
+ ============================================== ========== ========== =========== ======== ======= ========================================
2016
+ Element Type Units Constraints Required Default Notes
2017
+ ============================================== ========== ========== =========== ======== ======= ========================================
2018
+ ``SystemIdentifier`` id Yes Unique identifier
2019
+ ``Type`` string See [#]_ Yes Type of dehumidifier
2020
+ ``Location`` string See [#]_ Yes Location of dehumidifier
2021
+ ``Capacity`` double pints/day > 0 Yes Dehumidification capacity
2022
+ ``IntegratedEnergyFactor`` or ``EnergyFactor`` double liters/kWh > 0 Yes Rated efficiency
2023
+ ``DehumidistatSetpoint`` double frac 0 - 1 [#]_ Yes Relative humidity setpoint
2024
+ ``FractionDehumidificationLoadServed`` double frac 0 - 1 [#]_ Yes Fraction of dehumidification load served
2025
+ ============================================== ========== ========== =========== ======== ======= ========================================
2026
+
2027
+ .. [#] Type choices are "portable" or "whole-home".
2028
+ .. [#] Location only choice is "living space".
2029
+ .. [#] If multiple dehumidifiers are entered, they must all have the same setpoint or an error will be generated.
2030
+ .. [#] The sum of all ``FractionDehumidificationLoadServed`` (across all Dehumidifiers) must be less than or equal to 1.
2031
+
2032
+ .. note::
2033
+
2034
+ Dehumidifiers are currently modeled as located within conditioned space; the model is not suited for a dehumidifier in, e.g., a wet unconditioned basement or crawlspace.
2035
+ Therefore the dehumidifier Location is currently restricted to "living space".
2036
+
2037
+ HPXML Cooking Range/Oven
2038
+ ************************
2039
+
2040
+ A single cooking range can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/CookingRange``.
2041
+ If not entered, the simulation will not include a cooking range/oven.
2042
+
2043
+ ======================================== ======= ====== =========== ======== ============ ======================================
2044
+ Element Type Units Constraints Required Default Notes
2045
+ ======================================== ======= ====== =========== ======== ============ ======================================
2046
+ ``SystemIdentifier`` id Yes Unique identifier
2047
+ ``Location`` string See [#]_ No living space Location
2048
+ ``FuelType`` string See [#]_ Yes Fuel type
2049
+ ``IsInduction`` boolean No false Induction range?
2050
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
2051
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2052
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2053
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2054
+ ======================================== ======= ====== =========== ======== ============ ======================================
2055
+
2056
+ .. [#] 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".
2057
+ See :ref:`hpxmllocations` for descriptions.
2058
+ .. [#] 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".
2059
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 22 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.007, 0.007, 0.004, 0.004, 0.007, 0.011, 0.025, 0.042, 0.046, 0.048, 0.042, 0.050, 0.057, 0.046, 0.057, 0.044, 0.092, 0.150, 0.117, 0.060, 0.035, 0.025, 0.016, 0.011".
2060
+ .. [#] If MonthlyScheduleMultipliers not provided, 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".
2061
+
2062
+ If a cooking range is specified, a single oven is also entered as a ``/HPXML/Building/BuildingDetails/Appliances/Oven``.
2063
+
2064
+ ==================== ======= ====== =========== ======== ======= ================
2065
+ Element Type Units Constraints Required Default Notes
2066
+ ==================== ======= ====== =========== ======== ======= ================
2067
+ ``SystemIdentifier`` id Yes Unique identifier
2068
+ ``IsConvection`` boolean No false Convection oven?
2069
+ ==================== ======= ====== =========== ======== ======= ================
2070
+
2071
+ Cooking range/oven energy use is calculated per the Energy Rating Rated Home in `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2072
+
2073
+ HPXML Lighting & Ceiling Fans
2074
+ -----------------------------
2075
+
2076
+ Lighting and ceiling fans are entered in ``/HPXML/Building/BuildingDetails/Lighting``.
2077
+
2078
+ HPXML Lighting
2079
+ **************
2080
+
2081
+ Nine ``/HPXML/Building/BuildingDetails/Lighting/LightingGroup`` elements must be provided, each of which is the combination of:
2082
+
2083
+ - ``LightingType``: 'LightEmittingDiode', 'CompactFluorescent', and 'FluorescentTube'
2084
+ - ``Location``: 'interior', 'garage', and 'exterior'
2085
+
2086
+ Information is entered in each ``LightingGroup``.
2087
+
2088
+ ============================= ======= ====== =========== ======== ======= ===========================================================================
2089
+ Element Type Units Constraints Required Default Notes
2090
+ ============================= ======= ====== =========== ======== ======= ===========================================================================
2091
+ ``SystemIdentifier`` id Yes Unique identifier
2092
+ ``LightingType`` element 1 [#]_ Yes Lighting type
2093
+ ``Location`` string See [#]_ Yes See [#]_
2094
+ ``FractionofUnitsInLocation`` double frac 0 - 1 [#]_ Yes Fraction of light fixtures in the location with the specified lighting type
2095
+ ============================= ======= ====== =========== ======== ======= ===========================================================================
2096
+
2097
+ .. [#] LightingType child element choices are ``LightEmittingDiode``, ``CompactFluorescent``, or ``FluorescentTube``.
2098
+ .. [#] Location choices are "interior", "garage", or "exterior".
2099
+ .. [#] Garage lighting is ignored if the building has no garage specified elsewhere.
2100
+ .. [#] The sum of FractionofUnitsInLocation for a given Location (e.g., interior) must be less than or equal to 1.
2101
+ If the fractions sum to less than 1, the remainder is assumed to be incandescent lighting.
2102
+
2103
+ Additional information is entered in ``Lighting``.
2104
+
2105
+ ================================================ ======= ====== =========== ======== ======== ===============================================
2106
+ Element Type Units Constraints Required Default Notes
2107
+ ================================================ ======= ====== =========== ======== ======== ===============================================
2108
+ ``extension/InteriorUsageMultiplier`` double >= 0 No 1.0 Multiplier on interior lighting use
2109
+ ``extension/GarageUsageMultiplier`` double >= 0 No 1.0 Multiplier on garage lighting use
2110
+ ``extension/ExteriorUsageMultiplier`` double >= 0 No 1.0 Multiplier on exterior lighting use
2111
+ ``extension/InteriorWeekdayScheduleFractions`` array No See [#]_ 24 comma-separated interior weekday fractions
2112
+ ``extension/InteriorWeekendScheduleFractions`` array No 24 comma-separated interior weekend fractions
2113
+ ``extension/InteriorMonthlyScheduleMultipliers`` array No 12 comma-separated interior monthly multipliers
2114
+ ``extension/GarageWeekdayScheduleFractions`` array No See [#]_ 24 comma-separated garage weekday fractions
2115
+ ``extension/GarageWeekendScheduleFractions`` array No 24 comma-separated garage weekend fractions
2116
+ ``extension/GarageMonthlyScheduleMultipliers`` array No 12 comma-separated garage monthly multipliers
2117
+ ``extension/ExteriorWeekdayScheduleFractions`` array No See [#]_ 24 comma-separated exterior weekday fractions
2118
+ ``extension/ExteriorWeekendScheduleFractions`` array No 24 comma-separated exterior weekend fractions
2119
+ ``extension/ExteriorMonthlyScheduleMultipliers`` array No 12 comma-separated exterior monthly multipliers
2120
+ ``extension/ExteriorHolidayLighting`` element 0 - 1 No <none> Presence of additional holiday lighting?
2121
+ ================================================ ======= ====== =========== ======== ======== ===============================================
2122
+
2123
+ .. [#] If *interior* schedule values not provided, they will be calculated using Lighting Calculation Option 2 (location-dependent lighting profile) of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
2124
+ .. [#] If *garage* schedule values not provided, they will be defaulted using Appendix C Table 8 of the `Title 24 2016 Res. ACM Manual <https://ww2.energy.ca.gov/2015publications/CEC-400-2015-024/CEC-400-2015-024-CMF-REV2.pdf>`_.
2125
+ .. [#] If *exterior* schedule values not provided, they will be defaulted using Appendix C Table 8 of the `Title 24 2016 Res. ACM Manual <https://ww2.energy.ca.gov/2015publications/CEC-400-2015-024/CEC-400-2015-024-CMF-REV2.pdf>`_.
2126
+
2127
+ If exterior holiday lighting is specified, additional information is entered in ``extension/ExteriorHolidayLighting``.
2128
+
2129
+ =============================== ======= ======= =========== ======== ============= ============================================
2130
+ Element Type Units Constraints Required Default Notes
2131
+ =============================== ======= ======= =========== ======== ============= ============================================
2132
+ ``Load[Units="kWh/day"]/Value`` double kWh/day >= 0 No See [#]_ Holiday lighting energy use per day
2133
+ ``PeriodBeginMonth`` integer 1 - 12 No 11 (November) Holiday lighting start date
2134
+ ``PeriodBeginDayOfMonth`` integer 1 - 31 No 24 Holiday lighting start date
2135
+ ``PeriodEndMonth`` integer 1 - 12 No 1 (January) Holiday lighting end date
2136
+ ``PeriodEndDayOfMonth`` integer 1 - 31 No 6 Holiday lighting end date
2137
+ ``WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated holiday weekday fractions
2138
+ ``WeekendScheduleFractions`` array No 24 comma-separated holiday weekend fractions
2139
+ =============================== ======= ======= =========== ======== ============= ============================================
2140
+
2141
+ .. [#] If Value not provided, defaults to 1.1 for single-family detached and 0.55 for others.
2142
+ .. [#] If WeekdayScheduleFractions not provided, defaults to "0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0.008, 0.098, 0.168, 0.194, 0.284, 0.192, 0.037, 0.019".
2143
+
2144
+ Interior, exterior, and garage lighting energy use is calculated per the Energy Rating Rated Home in `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2145
+
2146
+ HPXML Ceiling Fans
2147
+ ******************
2148
+
2149
+ Each ceiling fan is entered as a ``/HPXML/Building/BuildingDetails/Lighting/CeilingFan``.
2150
+ If not entered, the simulation will not include a ceiling fan.
2151
+
2152
+ ========================================= ======= ======= =========== ======== ======== ==============================
2153
+ Element Type Units Constraints Required Default Notes
2154
+ ========================================= ======= ======= =========== ======== ======== ==============================
2155
+ ``SystemIdentifier`` id Yes Unique identifier
2156
+ ``Airflow[FanSpeed="medium"]/Efficiency`` double cfm/W > 0 No See [#]_ Efficiency at medium speed
2157
+ ``Quantity`` integer > 0 No See [#]_ Number of similar ceiling fans
2158
+ ========================================= ======= ======= =========== ======== ======== ==============================
2159
+
2160
+ .. [#] If Efficiency not provided, defaults to 3000 / 42.6 based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2161
+ .. [#] If Quantity not provided, defaults to NumberofBedrooms + 1 based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2162
+
2163
+ Ceiling fan energy use is calculated per the Energy Rating Rated Home in `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2164
+
2165
+ .. note::
2166
+
2167
+ A reduced cooling setpoint can be specified for summer months when ceiling fans are operating.
2168
+ See :ref:`hvac_control` for more information.
2169
+
2170
+ HPXML Pools & Hot Tubs
2171
+ ----------------------
2172
+
2173
+ HPXML Pools
2174
+ ***********
2175
+
2176
+ A single pool can be entered as a ``/HPXML/Building/BuildingDetails/Pools/Pool``.
2177
+ If not entered, the simulation will not include a pool.
2178
+
2179
+ ==================== ======= ====== =========== ======== ============ =================
2180
+ Element Type Units Constraints Required Default Notes
2181
+ ==================== ======= ====== =========== ======== ============ =================
2182
+ ``SystemIdentifier`` id Yes Unique identifier
2183
+ ``Type`` string See [#]_ Yes Pool type
2184
+ ==================== ======= ====== =========== ======== ============ =================
2185
+
2186
+ .. [#] Type choices are "in ground", "on ground", "above ground", "other", "unknown", or "none".
2187
+ If "none" is entered, the simulation will not include a pool.
2188
+
2189
+ Pool Pump
2190
+ ~~~~~~~~~
2191
+
2192
+ If a pool is specified, a single pool pump can be entered as a ``Pool/PoolPumps/PoolPump``.
2193
+ If not entered, the simulation will not include a pool heater.
2194
+
2195
+ ======================================== ======= ====== =========== ======== ============ ======================================
2196
+ Element Type Units Constraints Required Default Notes
2197
+ ======================================== ======= ====== =========== ======== ============ ======================================
2198
+ ``SystemIdentifier`` id Yes Unique identifier
2199
+ ``Type`` string See [#]_ Yes Pool pump type
2200
+ ``Load[Units="kWh/year"]/Value`` double kWh/yr >= 0 No See [#]_ Pool pump energy use
2201
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on pool pump energy use
2202
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2203
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2204
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2205
+ ======================================== ======= ====== =========== ======== ============ ======================================
2206
+
2207
+ .. [#] Type choices are "single speed", "multi speed", "variable speed", "variable flow", "other", "unknown", or "none".
2208
+ If "none" is entered, the simulation will not include a pool pump.
2209
+ .. [#] If Value not provided, defaults based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_: 158.5 / 0.070 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920).
2210
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.003, 0.003, 0.003, 0.004, 0.008, 0.015, 0.026, 0.044, 0.084, 0.121, 0.127, 0.121, 0.120, 0.090, 0.075, 0.061, 0.037, 0.023, 0.013, 0.008, 0.004, 0.003, 0.003, 0.003".
2211
+ .. [#] If MonthlyScheduleMultipliers not provided, 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.154, 1.161, 1.013, 1.010, 1.013, 0.888, 0.883, 0.883, 0.888, 0.978, 0.974, 1.154".
2212
+
2213
+ Pool Heater
2214
+ ~~~~~~~~~~~
2215
+
2216
+ If a pool is specified, a pool heater can be entered as a ``Pool/Heater``.
2217
+ If not entered, the simulation will not include a pool heater.
2218
+
2219
+ ====================================================== ======= ================== =========== ======== ======== ======================================
2220
+ Element Type Units Constraints Required Default Notes
2221
+ ====================================================== ======= ================== =========== ======== ======== ======================================
2222
+ ``SystemIdentifier`` id Yes Unique identifier
2223
+ ``Type`` string See [#]_ Yes Pool heater type
2224
+ ``Load[Units="kWh/year" or Units="therm/year"]/Value`` double kWh/yr or therm/yr >= 0 No See [#]_ Pool heater energy use
2225
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on pool heater energy use
2226
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2227
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2228
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2229
+ ====================================================== ======= ================== =========== ======== ======== ======================================
2230
+
2231
+ .. [#] Type choices are "none, "gas fired", "electric resistance", or "heat pump".
2232
+ If "none" is entered, the simulation will not include a pool heater.
2233
+ .. [#] If Value not provided, defaults as follows:
2234
+
2235
+ - **gas fired**: 3.0 / 0.014 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920) (based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2236
+ - **electric resistance**: 8.3 / 0.004 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920) (based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2237
+ - **heat pump**: (electric resistance) / 5.0 (based on an average COP of 5 from `Energy Saver <https://www.energy.gov/energysaver/heat-pump-swimming-pool-heaters>`_)
2238
+
2239
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.003, 0.003, 0.003, 0.004, 0.008, 0.015, 0.026, 0.044, 0.084, 0.121, 0.127, 0.121, 0.120, 0.090, 0.075, 0.061, 0.037, 0.023, 0.013, 0.008, 0.004, 0.003, 0.003, 0.003".
2240
+ .. [#] If MonthlyScheduleMultipliers not provided, 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.154, 1.161, 1.013, 1.010, 1.013, 0.888, 0.883, 0.883, 0.888, 0.978, 0.974, 1.154".
2241
+
2242
+ HPXML Hot Tubs
2243
+ **************
2244
+
2245
+ A single hot tub can be entered as a ``/HPXML/Building/BuildingDetails/HotTubs/HotTub``.
2246
+ If not entered, the simulation will not include a hot tub.
2247
+
2248
+ ==================== ======= ====== =========== ======== ============ =================
2249
+ Element Type Units Constraints Required Default Notes
2250
+ ==================== ======= ====== =========== ======== ============ =================
2251
+ ``SystemIdentifier`` id Yes Unique identifier
2252
+ ``Type`` string See [#]_ Yes Hot tub type
2253
+ ==================== ======= ====== =========== ======== ============ =================
2254
+
2255
+ .. [#] Type choices are "in ground", "on ground", "above ground", "other", "unknown", or "none".
2256
+ If "none" is entered, the simulation will not include a hot tub.
2257
+
2258
+ Hot Tub Pump
2259
+ ~~~~~~~~~~~~
2260
+
2261
+ If a hot tub is specified, a single hot tub pump can be entered as a ``HotTub/HotTubPumps/HotTubPump``.
2262
+ If not entered, the simulation will not include a hot tub pump.
2263
+
2264
+ ======================================== ======= ====== =========== ======== ============ ======================================
2265
+ Element Type Units Constraints Required Default Notes
2266
+ ======================================== ======= ====== =========== ======== ============ ======================================
2267
+ ``SystemIdentifier`` id Yes Unique identifier
2268
+ ``Type`` string See [#]_ Yes Hot tub pump type
2269
+ ``Load[Units="kWh/year"]/Value`` double kWh/yr >= 0 No See [#]_ Hot tub pump energy use
2270
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on hot tub pump energy use
2271
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2272
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2273
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2274
+ ======================================== ======= ====== =========== ======== ============ ======================================
2275
+
2276
+ .. [#] Type choices are "single speed", "multi speed", "variable speed", "variable flow", "other", "unknown", or "none".
2277
+ If "none" is entered, the simulation will not include a hot tub pump.
2278
+ .. [#] If Value not provided, defaults based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_: 59.5 / 0.059 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920).
2279
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.024, 0.029, 0.024, 0.029, 0.047, 0.067, 0.057, 0.024, 0.024, 0.019, 0.015, 0.014, 0.014, 0.014, 0.024, 0.058, 0.126, 0.122, 0.068, 0.061, 0.051, 0.043, 0.024, 0.024".
2280
+ .. [#] If MonthlyScheduleMultipliers not provided, default values from Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.921, 0.928, 0.921, 0.915, 0.921, 1.160, 1.158, 1.158, 1.160, 0.921, 0.915, 0.921".
2281
+
2282
+ Hot Tub Heater
2283
+ ~~~~~~~~~~~~~~
2284
+
2285
+ If a hot tub is specified, a hot tub heater can be entered as a ``HotTub/Heater``.
2286
+ If not entered, the simulation will not include a hot tub heater.
2287
+
2288
+ ====================================================== ======= ================== =========== ======== ======== =======================================
2289
+ Element Type Units Constraints Required Default Notes
2290
+ ====================================================== ======= ================== =========== ======== ======== =======================================
2291
+ ``SystemIdentifier`` id Yes Unique identifier
2292
+ ``Type`` string See [#]_ Yes Hot tub heater type
2293
+ ``Load[Units="kWh/year" or Units="therm/year"]/Value`` double kWh/yr or therm/yr >= 0 No See [#]_ Hot tub heater energy use
2294
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on hot tub heater energy use
2295
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2296
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2297
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2298
+ ====================================================== ======= ================== =========== ======== ======== =======================================
2299
+
2300
+ .. [#] Type choices are "none, "gas fired", "electric resistance", or "heat pump".
2301
+ If "none" is entered, the simulation will not include a hot tub heater.
2302
+ .. [#] If Value not provided, defaults as follows:
2303
+
2304
+ - **gas fired [therm/year]**: 0.87 / 0.011 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920) (based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2305
+ - **electric resistance [kWh/year]**: 49.0 / 0.048 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920) (based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2306
+ - **heat pump [kWh/year]** = (electric resistance) / 5.0 (based on an average COP of 5 from `Energy Saver <https://www.energy.gov/energysaver/heat-pump-swimming-pool-heaters>`_)
2307
+
2308
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.024, 0.029, 0.024, 0.029, 0.047, 0.067, 0.057, 0.024, 0.024, 0.019, 0.015, 0.014, 0.014, 0.014, 0.024, 0.058, 0.126, 0.122, 0.068, 0.061, 0.051, 0.043, 0.024, 0.024".
2309
+ .. [#] If MonthlyScheduleMultipliers not provided, default values from Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used: "0.837, 0.835, 1.084, 1.084, 1.084, 1.096, 1.096, 1.096, 1.096, 0.931, 0.925, 0.837".
2310
+
2311
+ HPXML Misc Loads
2312
+ ----------------
2313
+
2314
+ Miscellaneous loads are entered in ``/HPXML/Building/BuildingDetails/MiscLoads``.
2315
+
2316
+ HPXML Plug Loads
2317
+ ****************
2318
+
2319
+ Each type of plug load can be entered as a ``/HPXML/Building/BuildingDetails/MiscLoads/PlugLoad``.
2320
+
2321
+ It is required to include miscellaneous plug loads (PlugLoadType="other"), which represents all residual plug loads not explicitly captured elsewhere.
2322
+ It is common to include television plug loads (PlugLoadType="TV other"), which represents all television energy use in the home.
2323
+ It is less common to include the other plug load types, as they are less frequently found in homes.
2324
+ If not entered, the simulation will not include that type of plug load.
2325
+
2326
+ ======================================== ======= ====== =========== ======== ======== =============================================================
2327
+ Element Type Units Constraints Required Default Notes
2328
+ ======================================== ======= ====== =========== ======== ======== =============================================================
2329
+ ``SystemIdentifier`` id Yes Unique identifier
2330
+ ``PlugLoadType`` string See [#]_ Yes Type of plug load
2331
+ ``Load[Units="kWh/year"]/Value`` double kWh/yr >= 0 No See [#]_ Annual electricity consumption
2332
+ ``extension/FracSensible`` double 0 - 1 No See [#]_ Fraction that is sensible heat gain to conditioned space [#]_
2333
+ ``extension/FracLatent`` double 0 - 1 No See [#]_ Fraction that is latent heat gain to conditioned space
2334
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on electricity use
2335
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2336
+ ``extension/WeekendScheduleFractions`` array No See [#]_ 24 comma-separated weekend fractions
2337
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2338
+ ======================================== ======= ====== =========== ======== ======== =============================================================
2339
+
2340
+ .. [#] PlugLoadType choices are "other", "TV other", "well pump", or "electric vehicle charging".
2341
+ .. [#] If Value not provided, defaults as:
2342
+
2343
+ - **other**: 0.91 * ConditionedFloorArea (based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_)
2344
+ - **TV other**: 413.0 + 69.0 * NumberofBedrooms (based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_)
2345
+ - **well pump**: 50.8 / 0.127 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920) (based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2346
+ - **electric vehicle charging**: 1666.67 (calculated using AnnualMiles * kWhPerMile / (ChargerEfficiency * BatteryEfficiency) where AnnualMiles=4500, kWhPerMile=0.3, ChargerEfficiency=0.9, and BatteryEfficiency=0.9)
2347
+
2348
+ .. [#] If FracSensible not provided, defaults as:
2349
+
2350
+ - **other**: 0.855
2351
+ - **TV other**: 1.0
2352
+ - **well pump**: 0.0
2353
+ - **electric vehicle charging**: 0.0
2354
+
2355
+ .. [#] The remaining fraction (i.e., 1.0 - FracSensible - FracLatent) must be > 0 and is assumed to be heat gain outside conditioned space and thus lost.
2356
+ .. [#] If FracLatent not provided, defaults as:
2357
+
2358
+ - **other**: 0.045
2359
+ - **TV other**: 0.0
2360
+ - **well pump**: 0.0
2361
+ - **electric vehicle charging**: 0.0
2362
+
2363
+ .. [#] If WeekdayScheduleFractions not provided, defaults as:
2364
+
2365
+ - **other**: "0.035, 0.033, 0.032, 0.031, 0.032, 0.033, 0.037, 0.042, 0.043, 0.043, 0.043, 0.044, 0.045, 0.045, 0.044, 0.046, 0.048, 0.052, 0.053, 0.05, 0.047, 0.045, 0.04, 0.036" (based on Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2366
+ - **TV other**: "0.037, 0.018, 0.009, 0.007, 0.011, 0.018, 0.029, 0.040, 0.049, 0.058, 0.065, 0.072, 0.076, 0.086, 0.091, 0.102, 0.127, 0.156, 0.210, 0.294, 0.363, 0.344, 0.208, 0.090" (based on the `American Time Use Survey <https://www.bls.gov/tus>`_)
2367
+ - **well pump**: "0.044, 0.023, 0.019, 0.015, 0.016, 0.018, 0.026, 0.033, 0.033, 0.032, 0.033, 0.033, 0.032, 0.032, 0.032, 0.033, 0.045, 0.057, 0.066, 0.076, 0.081, 0.086, 0.075, 0.065" (based on Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2368
+ - **electric vehicle charging**: "0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042"
2369
+
2370
+ .. [#] If WeekdendScheduleFractions not provided, defaults as:
2371
+
2372
+ - **other**: "0.035, 0.033, 0.032, 0.031, 0.032, 0.033, 0.037, 0.042, 0.043, 0.043, 0.043, 0.044, 0.045, 0.045, 0.044, 0.046, 0.048, 0.052, 0.053, 0.05, 0.047, 0.045, 0.04, 0.036" (based on Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2373
+ - **TV other**: "0.044, 0.022, 0.012, 0.008, 0.011, 0.014, 0.024, 0.043, 0.071, 0.094, 0.112, 0.123, 0.132, 0.156, 0.178, 0.196, 0.206, 0.213, 0.251, 0.330, 0.388, 0.358, 0.226, 0.103" (based on the `American Time Use Survey <https://www.bls.gov/tus>`_)
2374
+ - **well pump**: "0.044, 0.023, 0.019, 0.015, 0.016, 0.018, 0.026, 0.033, 0.033, 0.032, 0.033, 0.033, 0.032, 0.032, 0.032, 0.033, 0.045, 0.057, 0.066, 0.076, 0.081, 0.086, 0.075, 0.065" (based on Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2375
+ - **electric vehicle charging**: "0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042"
2376
+
2377
+ .. [#] If MonthlyScheduleMultipliers not provided, defaults as:
2378
+
2379
+ - **other**: "1.248, 1.257, 0.993, 0.989, 0.993, 0.827, 0.821, 0.821, 0.827, 0.99, 0.987, 1.248" (based on Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2380
+ - **TV other**: "1.137, 1.129, 0.961, 0.969, 0.961, 0.993, 0.996, 0.96, 0.993, 0.867, 0.86, 1.137" (based on the `American Time Use Survey <https://www.bls.gov/tus>`_)
2381
+ - **well pump**: "1.154, 1.161, 1.013, 1.010, 1.013, 0.888, 0.883, 0.883, 0.888, 0.978, 0.974, 1.154" (based on Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_)
2382
+ - **electric vehicle charging**: "1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0"
2383
+
2384
+ HPXML Fuel Loads
2385
+ ****************
2386
+
2387
+ Each fuel load can be entered as a ``/HPXML/Building/BuildingDetails/MiscLoads/FuelLoad``.
2388
+
2389
+ It is less common to include fuel load types, as they are less frequently found in homes.
2390
+ If not entered, the simulation will not include that type of fuel load.
2391
+
2392
+ ======================================== ======= ======== =========== ======== ======== =============================================================
2393
+ Element Type Units Constraints Required Default Notes
2394
+ ======================================== ======= ======== =========== ======== ======== =============================================================
2395
+ ``SystemIdentifier`` id Yes Unique identifier
2396
+ ``FuelLoadType`` string See [#]_ Yes Type of fuel load
2397
+ ``Load[Units="therm/year"]/Value`` double therm/yr >= 0 No See [#]_ Annual fuel consumption
2398
+ ``FuelType`` string See [#]_ Yes Fuel type
2399
+ ``extension/FracSensible`` double 0 - 1 No See [#]_ Fraction that is sensible heat gain to conditioned space [#]_
2400
+ ``extension/FracLatent`` double 0 - 1 No See [#]_ Fraction that is latent heat gain to conditioned space
2401
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on fuel use
2402
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2403
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2404
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2405
+ ======================================== ======= ======== =========== ======== ======== =============================================================
2406
+
2407
+ .. [#] FuelLoadType choices are "grill", "fireplace", or "lighting".
2408
+ .. [#] If Value not provided, calculated as based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_:
2409
+
2410
+ - **grill**: 0.87 / 0.029 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920)
2411
+ - **fireplace**: 1.95 / 0.032 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920)
2412
+ - **lighting**: 0.22 / 0.012 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920)
2413
+
2414
+ .. [#] 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", "wood", or "wood pellets".
2415
+ .. [#] If FracSensible not provided, defaults to 0.5 for fireplace and 0.0 for all other types.
2416
+ .. [#] The remaining fraction (i.e., 1.0 - FracSensible - FracLatent) must be > 0 and is assumed to be heat gain outside conditioned space and thus lost.
2417
+ .. [#] If FracLatent not provided, defaults to 0.1 for fireplace and 0.0 for all other types.
2418
+ .. [#] If WeekdayScheduleFractions or WeekendScheduleFractions not provided, default values from Figure 23 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used:
2419
+
2420
+ - **grill**: "0.004, 0.001, 0.001, 0.002, 0.007, 0.012, 0.029, 0.046, 0.044, 0.041, 0.044, 0.046, 0.042, 0.038, 0.049, 0.059, 0.110, 0.161, 0.115, 0.070, 0.044, 0.019, 0.013, 0.007";
2421
+ - **fireplace**: "0.044, 0.023, 0.019, 0.015, 0.016, 0.018, 0.026, 0.033, 0.033, 0.032, 0.033, 0.033, 0.032, 0.032, 0.032, 0.033, 0.045, 0.057, 0.066, 0.076, 0.081, 0.086, 0.075, 0.065";
2422
+ - **lighting**: "0.044, 0.023, 0.019, 0.015, 0.016, 0.018, 0.026, 0.033, 0.033, 0.032, 0.033, 0.033, 0.032, 0.032, 0.032, 0.033, 0.045, 0.057, 0.066, 0.076, 0.081, 0.086, 0.075, 0.065".
2423
+
2424
+ .. [#] If MonthlyScheduleMultipliers not provided, default values from Figure 24 of the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_ are used:
2425
+
2426
+ - **grill**: "1.097, 1.097, 0.991, 0.987, 0.991, 0.890, 0.896, 0.896, 0.890, 1.085, 1.085, 1.097";
2427
+ - **fireplace**: "1.154, 1.161, 1.013, 1.010, 1.013, 0.888, 0.883, 0.883, 0.888, 0.978, 0.974, 1.154";
2428
+ - **lighting**: "1.154, 1.161, 1.013, 1.010, 1.013, 0.888, 0.883, 0.883, 0.888, 0.978, 0.974, 1.154".
2429
+
2430
+ .. _hpxmllocations:
2431
+
2432
+ HPXML Locations
2433
+ ---------------
2434
+
2435
+ The various locations used in an HPXML file are defined as follows:
2436
+
2437
+ ============================== ======================================================= ======================================= =============
2438
+ Value Description Temperature Building Type
2439
+ ============================== ======================================================= ======================================= =============
2440
+ outside Ambient environment Weather data Any
2441
+ ground EnergyPlus calculation Any
2442
+ living space Above-grade conditioned floor area EnergyPlus calculation Any
2443
+ attic - vented EnergyPlus calculation Any
2444
+ attic - unvented EnergyPlus calculation Any
2445
+ basement - conditioned Below-grade conditioned floor area EnergyPlus calculation Any
2446
+ basement - unconditioned EnergyPlus calculation Any
2447
+ crawlspace - vented EnergyPlus calculation Any
2448
+ crawlspace - unvented EnergyPlus calculation Any
2449
+ garage Single-family garage (not shared parking) EnergyPlus calculation Any
2450
+ other housing unit E.g., conditioned adjacent unit or conditioned corridor Same as living space SFA/MF only
2451
+ other heated space E.g., shared laundry/equipment space Avg of living space/outside; min of 68F SFA/MF only
2452
+ other multifamily buffer space E.g., enclosed unconditioned stairwell Avg of living space/outside; min of 50F SFA/MF only
2453
+ other non-freezing space E.g., shared parking garage ceiling Floats with outside; minimum of 40F SFA/MF only
2454
+ other exterior Water heater outside Weather data Any
2455
+ exterior wall Ducts in exterior wall Avg of living space/outside Any
2456
+ under slab Ducts under slab (ground) EnergyPlus calculation Any
2457
+ roof deck Ducts on roof deck (outside) Weather data Any
2458
+ ============================== ======================================================= ======================================= =============
2459
+
2460
+ Validating & Debugging Errors
2461
+ -----------------------------
2462
+
2463
+ When running HPXML files, errors may occur because:
2464
+
2465
+ #. An HPXML file provided is invalid (either relative to the HPXML schema or the EnergyPlus Use Case).
2466
+ #. An unexpected EnergyPlus simulation error occurred.
2467
+
2468
+ If an error occurs, first look in the run.log for details.
2469
+ If there are no errors in that log file, then the error may be in the EnergyPlus simulation -- see eplusout.err.
2470
+
2471
+ Contact us if you can't figure out the cause of an error.
2472
+
2473
+ Sample Files
2474
+ ------------
2475
+
2476
+ Dozens of sample HPXML files are included in the workflow/sample_files directory.
2477
+ The sample files help to illustrate how different building components are described in HPXML.
2478
+
2479
+ Each sample file generally makes one isolated change relative to the base HPXML (base.xml) building.
2480
+ For example, the base-dhw-dwhr.xml file adds a ``DrainWaterHeatRecovery`` element to the building.
2481
+
2482
+ You may find it useful to search through the files for certain HPXML elements or compare (diff) a sample file to the base.xml file.