urbanopt-cli 0.4.1 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (691) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/CMakeLists.txt +9 -9
  4. data/Gemfile +10 -12
  5. data/README.md +1 -0
  6. data/example_files/Gemfile +26 -10
  7. data/example_files/mappers/Baseline.rb +9 -0
  8. data/example_files/mappers/CreateBar.rb +2 -0
  9. data/example_files/mappers/Floorspace.rb +12 -10
  10. data/example_files/mappers/floorspace_workflow.osw +9 -0
  11. data/example_files/residential/clothes_washer.tsv +1 -1
  12. data/example_files/residential/water_heater.tsv +1 -1
  13. data/example_files/resources/hpxml-measures/.circleci/config.yml +20 -0
  14. data/example_files/resources/hpxml-measures/.github/pull_request_template.md +13 -0
  15. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/measure.rb +583 -334
  16. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/measure.xml +687 -586
  17. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/geometry.rb +21 -22
  18. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules.rb +34 -24
  19. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_config.yml +14 -1
  20. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-coal.osw +33 -35
  21. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-dehumidifier-50percent.osw +33 -35
  22. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-appliances-dehumidifier-ief.osw → base-appliances-dehumidifier-ief-portable.osw} +34 -36
  23. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-dehumidifier-ief-whole-home.osw +361 -0
  24. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-dehumidifier.osw +33 -35
  25. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-gas.osw +33 -35
  26. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-modified.osw +33 -35
  27. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-none.osw +33 -35
  28. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-oil.osw +33 -35
  29. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-propane.osw +33 -35
  30. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-wood.osw +33 -35
  31. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-flat.osw +33 -35
  32. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-radiant-barrier.osw +33 -35
  33. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-unvented-insulated-roof.osw +33 -35
  34. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-atticroof-vented.osw +33 -35
  35. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-mechvent-shared-preconditioning.osw → base-bldgtype-multifamily-shared-mechvent-preconditioning.osw} +47 -48
  36. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-mechvent-shared.osw → base-bldgtype-multifamily-shared-mechvent.osw} +47 -48
  37. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-pv-shared.osw → base-bldgtype-multifamily-shared-pv.osw} +49 -50
  38. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-bldgtype-multifamily-shared-water-heater.osw +365 -0
  39. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-multifamily.osw → base-bldgtype-multifamily.osw} +43 -44
  40. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-single-family-attached.osw → base-bldgtype-single-family-attached.osw} +36 -38
  41. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-combi-tankless-outside.osw +33 -34
  42. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-combi-tankless.osw +33 -34
  43. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-dwhr.osw +33 -35
  44. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect-outside.osw +33 -34
  45. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect-standbyloss.osw +33 -34
  46. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect-with-solar-fraction.osw +33 -34
  47. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-indirect.osw +33 -34
  48. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-electric.osw +33 -35
  49. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-gas.osw +33 -35
  50. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-hpwh.osw +33 -35
  51. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-jacket-indirect.osw +33 -34
  52. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-low-flow-fixtures.osw +33 -35
  53. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-none.osw +33 -35
  54. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-demand.osw +33 -35
  55. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-manual.osw +33 -35
  56. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-nocontrol.osw +33 -35
  57. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-temperature.osw +33 -35
  58. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-recirc-timer.osw +33 -35
  59. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-direct-evacuated-tube.osw +33 -35
  60. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-direct-flat-plate.osw +33 -35
  61. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-direct-ics.osw +33 -35
  62. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-fraction.osw +33 -35
  63. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-indirect-flat-plate.osw +33 -35
  64. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-solar-thermosyphon-flat-plate.osw +33 -35
  65. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-coal.osw +33 -35
  66. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-elec-uef.osw +362 -0
  67. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-gas-outside.osw +33 -35
  68. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-gas-uef.osw +362 -0
  69. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-gas.osw +33 -35
  70. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-outside.osw +33 -35
  71. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-uef.osw +362 -0
  72. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-with-solar-fraction.osw +33 -35
  73. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump-with-solar.osw +33 -35
  74. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-heat-pump.osw +33 -35
  75. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-oil.osw +33 -35
  76. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tank-wood.osw +33 -35
  77. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-electric-outside.osw +33 -36
  78. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-electric-uef.osw +361 -0
  79. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-electric.osw +33 -35
  80. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas-uef.osw +361 -0
  81. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas-with-solar-fraction.osw +33 -35
  82. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas-with-solar.osw +33 -35
  83. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-gas.osw +33 -35
  84. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-dhw-tankless-propane.osw +33 -35
  85. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-2stories-garage.osw +33 -35
  86. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-2stories.osw +33 -35
  87. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-1.osw +33 -35
  88. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-2.osw +33 -35
  89. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-4.osw +33 -35
  90. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-beds-5.osw +33 -35
  91. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-garage.osw +33 -35
  92. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-ach-house-pressure.osw +33 -35
  93. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-cfm-house-pressure.osw +33 -35
  94. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-cfm50.osw +33 -35
  95. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-flue.osw +33 -35
  96. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-infil-natural-ach.osw +33 -35
  97. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-overhangs.osw +33 -35
  98. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-enclosure-windows-none.osw +33 -35
  99. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-ambient.osw +33 -35
  100. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-conditioned-basement-slab-insulation.osw +33 -35
  101. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-slab.osw +33 -35
  102. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unconditioned-basement-assembly-r.osw +33 -35
  103. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unconditioned-basement-wall-insulation.osw +33 -35
  104. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unconditioned-basement.osw +33 -35
  105. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-unvented-crawlspace.osw +33 -35
  106. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-foundation-vented-crawlspace.osw +33 -35
  107. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-1-speed.osw +34 -35
  108. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-2-speed.osw +33 -35
  109. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-air-to-air-heat-pump-var-speed.osw +33 -35
  110. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-coal-only.osw +33 -35
  111. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-elec-only.osw +33 -35
  112. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-gas-central-ac-1-speed.osw +33 -34
  113. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-gas-only.osw +33 -34
  114. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-oil-only.osw +33 -35
  115. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-propane-only.osw +33 -35
  116. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-boiler-wood-only.osw +33 -35
  117. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-only-1-speed.osw +34 -35
  118. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-only-2-speed.osw +33 -35
  119. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-only-var-speed.osw +33 -35
  120. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-central-ac-plus-air-to-air-heat-pump-heating.osw +35 -35
  121. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed-electric.osw +34 -35
  122. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed.osw +34 -35
  123. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-2-speed.osw +33 -35
  124. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-air-to-air-heat-pump-var-speed.osw +33 -35
  125. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-dual-fuel-mini-split-heat-pump-ducted.osw +34 -35
  126. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-ducts-leakage-percent.osw +33 -35
  127. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-elec-resistance-only.osw +33 -35
  128. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-evap-cooler-furnace-gas.osw +33 -35
  129. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-evap-cooler-only-ducted.osw +33 -35
  130. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-evap-cooler-only.osw +34 -35
  131. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-fireplace-wood-only.osw +34 -35
  132. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-fixed-heater-gas-only.osw +34 -35
  133. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-floor-furnace-propane-only.osw +34 -35
  134. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-elec-central-ac-1-speed.osw +33 -35
  135. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-elec-only.osw +33 -35
  136. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-central-ac-2-speed.osw +33 -35
  137. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-central-ac-var-speed.osw +33 -35
  138. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-only.osw +34 -35
  139. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-gas-room-ac.osw +33 -35
  140. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-oil-only.osw +33 -35
  141. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-propane-only.osw +33 -35
  142. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-furnace-wood-only.osw +33 -35
  143. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-ground-to-air-heat-pump.osw +35 -37
  144. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-air-conditioner-only-ducted.osw +34 -35
  145. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-air-conditioner-only-ductless.osw +34 -35
  146. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ducted-cooling-only.osw +34 -35
  147. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ducted-heating-only.osw +34 -35
  148. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ducted.osw +34 -35
  149. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-mini-split-heat-pump-ductless.osw +34 -35
  150. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-none.osw +33 -35
  151. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-portable-heater-gas-only.osw +34 -35
  152. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-room-ac-only-33percent.osw +33 -35
  153. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-room-ac-only.osw +33 -35
  154. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-setpoints.osw +33 -35
  155. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-stove-oil-only.osw +34 -35
  156. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-stove-wood-pellets-only.osw +34 -35
  157. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-undersized.osw +33 -35
  158. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-hvac-wall-furnace-elec-only.osw +34 -35
  159. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-lighting-ceiling-fans.osw +34 -36
  160. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-lighting-detailed.osw +33 -35
  161. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-AMY-2012.osw +33 -35
  162. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-baltimore-md.osw +33 -35
  163. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-dallas-tx.osw +33 -35
  164. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-duluth-mn.osw +33 -35
  165. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-location-miami-fl.osw +33 -35
  166. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-balanced.osw +33 -35
  167. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-bath-kitchen-fans.osw +33 -35
  168. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-cfis-evap-cooler-only-ducted.osw +33 -35
  169. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-cfis.osw +33 -35
  170. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-erv-atre-asre.osw +33 -35
  171. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-erv.osw +33 -35
  172. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-exhaust.osw +33 -35
  173. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-hrv-asre.osw +33 -35
  174. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-hrv.osw +33 -35
  175. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-supply.osw +33 -35
  176. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-mechvent-whole-house-fan.osw +33 -35
  177. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-defaults.osw +36 -38
  178. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-loads-large-uncommon.osw +39 -41
  179. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-loads-large-uncommon2.osw +39 -41
  180. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-neighbor-shading.osw +33 -35
  181. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-misc-usage-multiplier.osw +30 -32
  182. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-pv.osw +29 -31
  183. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-schedules-stochastic.osw +33 -35
  184. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-schedules-user-specified.osw +33 -35
  185. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-calendar-year-custom.osw +33 -35
  186. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-daylight-saving-custom.osw +33 -35
  187. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-daylight-saving-disabled.osw +33 -35
  188. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-runperiod-1-month.osw +33 -35
  189. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-simcontrol-timestep-10-mins.osw +33 -35
  190. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base.osw +33 -35
  191. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/build_residential_hpxml_test.rb +19 -8
  192. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-auto.osw +33 -35
  193. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-dhw-solar-latitude.osw +33 -35
  194. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-enclosure-garage-partially-protruded.osw +33 -35
  195. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-hvac-programmable-thermostat.osw +369 -0
  196. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-plug-loads-additional-multipliers.osw +361 -0
  197. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-pv-roofpitch.osw +33 -35
  198. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{extra-dhw-shared-water-heater.osw → extra-schedules-random-seed.osw} +47 -50
  199. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-heating-system-fireplace.osw +33 -35
  200. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-heating-system-portable-heater.osw +33 -35
  201. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-second-refrigerator.osw +33 -35
  202. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/extra-vacancy-6-months.osw +33 -35
  203. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/conditioned-attic-with-floor-insulation.osw +33 -35
  204. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/conditioned-basement-with-ceiling-insulation.osw +33 -35
  205. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/cooling-system-and-heat-pump.osw +33 -35
  206. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/dhw-indirect-without-boiler.osw +33 -35
  207. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/ducts-location-and-areas-not-same-type.osw +33 -35
  208. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/heating-system-and-heat-pump.osw +33 -35
  209. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multifamily-bottom-crawlspace-zero-foundation-height.osw +41 -42
  210. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multifamily-bottom-slab-non-zero-foundation-height.osw +41 -42
  211. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/multifamily-no-building-orientation.osw +40 -41
  212. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-hvac-programmable-thermostat.osw → invalid_files/multipliers-without-fuel-loads.osw} +31 -33
  213. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/{base-dhw-uef.osw → invalid_files/multipliers-without-plug-loads.osw} +35 -37
  214. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/non-electric-heat-pump-water-heater.osw +33 -35
  215. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/non-integer-ceiling-fan-quantity.osw +33 -35
  216. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/non-integer-geometry-num-bathrooms.osw +33 -35
  217. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/second-heating-system-serves-majority-heat.osw +33 -35
  218. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-attached-ambient.osw +35 -37
  219. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-attached-no-building-orientation.osw +35 -37
  220. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-detached-finished-basement-zero-foundation-height.osw +33 -35
  221. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/single-family-detached-slab-non-zero-foundation-height.osw +33 -35
  222. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/slab-non-zero-foundation-height-above-grade.osw +33 -35
  223. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/unconditioned-basement-with-wall-and-ceiling-insulation.osw +33 -35
  224. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/unvented-attic-with-floor-and-roof-insulation.osw +33 -35
  225. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/unvented-crawlspace-with-wall-and-ceiling-insulation.osw +36 -38
  226. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/vented-attic-with-floor-and-roof-insulation.osw +33 -35
  227. data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/invalid_files/vented-crawlspace-with-wall-and-ceiling-insulation.osw +33 -35
  228. data/example_files/resources/hpxml-measures/Gemfile +0 -2
  229. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/measure.rb +141 -129
  230. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml +183 -153
  231. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/BaseElements.xsd +4 -4
  232. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/EPvalidator.xml +247 -121
  233. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/HPXMLDataTypes.xsd +0 -10
  234. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/HPXMLvalidator.xml +434 -0
  235. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/airflow.rb +28 -35
  236. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/constants.rb +4 -12
  237. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/constructions.rb +60 -53
  238. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/energyplus.rb +11 -15
  239. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/generator.rb +81 -0
  240. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/geometry.rb +3 -1
  241. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hotwater_appliances.rb +21 -12
  242. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml.rb +1150 -1072
  243. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hpxml_defaults.rb +799 -389
  244. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hvac.rb +227 -351
  245. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/hvac_sizing.rb +122 -89
  246. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/lighting.rb +1 -1
  247. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/location.rb +2 -3
  248. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/meta_measure.rb +0 -6
  249. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/misc_loads.rb +8 -13
  250. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/pv.rb +23 -21
  251. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/schedules.rb +8 -7
  252. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/simcontrols.rb +2 -2
  253. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/validator.rb +80 -19
  254. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/version.rb +9 -2
  255. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/waterheater.rb +103 -72
  256. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/xmlhelper.rb +110 -37
  257. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_airflow.rb +16 -7
  258. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_constructions.rb +109 -0
  259. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_defaults.rb +1747 -838
  260. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_generator.rb +99 -0
  261. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hotwater_appliance.rb +5 -16
  262. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hvac.rb +23 -25
  263. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_hvac_sizing.rb +54 -0
  264. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_lighting.rb +1 -1
  265. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_location.rb +10 -10
  266. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_miscloads.rb +1 -1
  267. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_pv.rb +2 -2
  268. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_simcontrols.rb +10 -10
  269. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_validation.rb +77 -60
  270. data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_water_heater.rb +186 -34
  271. data/example_files/resources/hpxml-measures/README.md +1 -0
  272. data/example_files/resources/hpxml-measures/Rakefile +2 -9
  273. data/example_files/resources/hpxml-measures/SimulationOutputReport/measure.rb +278 -254
  274. data/example_files/resources/hpxml-measures/SimulationOutputReport/measure.xml +32 -5
  275. data/example_files/resources/hpxml-measures/SimulationOutputReport/resources/constants.rb +1 -2
  276. data/example_files/resources/hpxml-measures/SimulationOutputReport/tests/output_report_test.rb +73 -137
  277. data/example_files/resources/hpxml-measures/docs/source/build_residential_hpxml.rst +3 -3
  278. data/example_files/resources/hpxml-measures/docs/source/conf.py +7 -4
  279. data/example_files/resources/hpxml-measures/docs/source/getting_started.rst +4 -4
  280. data/example_files/resources/hpxml-measures/docs/source/index.rst +2 -2
  281. data/example_files/resources/hpxml-measures/docs/source/intro.rst +4 -5
  282. data/example_files/resources/hpxml-measures/docs/source/nstatic/stylesheet.css +13 -1
  283. data/example_files/resources/hpxml-measures/docs/source/workflow_inputs.rst +2340 -0
  284. data/example_files/resources/hpxml-measures/docs/source/{simulation_output_report.rst → workflow_outputs.rst} +18 -16
  285. data/example_files/resources/hpxml-measures/tasks.rb +1154 -669
  286. data/example_files/resources/hpxml-measures/workflow/run_simulation.rb +64 -20
  287. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-coal.xml +557 -559
  288. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier-50percent.xml +523 -524
  289. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-appliances-dehumidifier-ief.xml → base-appliances-dehumidifier-ief-portable.xml} +3 -4
  290. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier-ief-whole-home.xml +524 -0
  291. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-dehumidifier.xml +523 -524
  292. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-gas.xml +557 -559
  293. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-modified.xml +563 -565
  294. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-none.xml +511 -513
  295. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-oil.xml +557 -559
  296. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-propane.xml +557 -559
  297. data/example_files/resources/hpxml-measures/workflow/sample_files/base-appliances-wood.xml +557 -559
  298. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-cathedral.xml +564 -566
  299. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-conditioned.xml +632 -634
  300. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-flat.xml +530 -532
  301. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-radiant-barrier.xml +516 -518
  302. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-unvented-insulated-roof.xml +561 -563
  303. data/example_files/resources/hpxml-measures/workflow/sample_files/base-atticroof-vented.xml +564 -566
  304. 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} +30 -59
  305. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-adjacent-to-multiple.xml +553 -0
  306. 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} +30 -59
  307. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-enclosure-other-heated-space.xml → base-bldgtype-multifamily-adjacent-to-other-heated-space.xml} +30 -59
  308. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-enclosure-other-housing-unit.xml → base-bldgtype-multifamily-adjacent-to-other-housing-unit.xml} +30 -59
  309. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-baseboard.xml +426 -0
  310. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-fan-coil-ducted.xml +457 -0
  311. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-fan-coil.xml +429 -0
  312. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-chiller-water-loop-heat-pump.xml +469 -0
  313. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-cooling-tower-water-loop-heat-pump.xml +464 -0
  314. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-baseboard.xml +409 -0
  315. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil-ducted.xml +439 -0
  316. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil-eae.xml +408 -0
  317. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-fan-coil.xml +411 -0
  318. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-boiler-only-water-loop-heat-pump.xml +445 -0
  319. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-baseboard.xml +408 -0
  320. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-fan-coil-ducted.xml +438 -0
  321. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-fan-coil.xml +410 -0
  322. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-chiller-only-water-loop-heat-pump.xml +445 -0
  323. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-cooling-tower-only-water-loop-heat-pump.xml +440 -0
  324. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-generator.xml +459 -0
  325. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-ground-loop-ground-to-air-heat-pump.xml +451 -0
  326. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-laundry-room.xml +465 -0
  327. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-mechvent-shared-multiple.xml → base-bldgtype-multifamily-shared-mechvent-multiple.xml} +35 -410
  328. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-mechvent-preconditioning.xml +488 -0
  329. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-mechvent.xml +472 -0
  330. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-pv.xml +464 -0
  331. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-water-heater-recirc.xml +457 -0
  332. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily-shared-water-heater.xml +450 -0
  333. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-multifamily.xml +447 -0
  334. data/example_files/resources/hpxml-measures/workflow/sample_files/base-bldgtype-single-family-attached.xml +606 -0
  335. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-combi-tankless-outside.xml +517 -519
  336. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-combi-tankless.xml +517 -519
  337. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-2-speed.xml +549 -551
  338. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-gshp.xml +564 -566
  339. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-hpwh.xml +562 -564
  340. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-tankless.xml +550 -549
  341. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater-var-speed.xml +549 -551
  342. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-desuperheater.xml +552 -551
  343. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-dwhr.xml +566 -568
  344. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-dse.xml +518 -520
  345. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-outside.xml +518 -520
  346. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-standbyloss.xml +519 -521
  347. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect-with-solar-fraction.xml +526 -528
  348. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-indirect.xml +518 -520
  349. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-electric.xml +566 -568
  350. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-gas.xml +567 -569
  351. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-hpwh.xml +565 -567
  352. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-jacket-indirect.xml +523 -525
  353. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-low-flow-fixtures.xml +561 -563
  354. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-multiple.xml +576 -578
  355. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-none.xml +495 -497
  356. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-demand.xml +564 -566
  357. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-manual.xml +564 -566
  358. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-nocontrol.xml +564 -566
  359. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-temperature.xml +564 -566
  360. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-recirc-timer.xml +564 -566
  361. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-evacuated-tube.xml +576 -578
  362. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-flat-plate.xml +576 -578
  363. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-direct-ics.xml +576 -578
  364. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-fraction.xml +569 -571
  365. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-indirect-flat-plate.xml +576 -578
  366. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-solar-thermosyphon-flat-plate.xml +576 -578
  367. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-coal.xml +562 -564
  368. data/example_files/resources/hpxml-measures/workflow/sample_files/{invalid_files/invalid-window-interior-shading.xml → base-dhw-tank-elec-uef.xml} +8 -9
  369. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas-outside.xml +562 -564
  370. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas-uef.xml +564 -0
  371. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-gas.xml +562 -564
  372. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-outside.xml +560 -562
  373. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-hvac-flowrate.xml → base-dhw-tank-heat-pump-uef.xml} +6 -13
  374. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-with-solar-fraction.xml +568 -570
  375. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump-with-solar.xml +575 -577
  376. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-heat-pump.xml +560 -562
  377. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-oil.xml +562 -564
  378. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tank-wood.xml +562 -564
  379. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric-outside.xml +560 -562
  380. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric-uef.xml +560 -0
  381. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-electric.xml +559 -561
  382. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-uef.xml +560 -0
  383. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-with-solar-fraction.xml +567 -569
  384. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas-with-solar.xml +574 -576
  385. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-gas.xml +559 -561
  386. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-tankless-propane.xml +559 -561
  387. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-2stories-garage.xml +660 -664
  388. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-2stories.xml +574 -576
  389. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-1.xml +561 -563
  390. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-2.xml +561 -563
  391. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-4.xml +561 -563
  392. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-beds-5.xml +561 -563
  393. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-garage.xml +635 -639
  394. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-ach-house-pressure.xml +561 -563
  395. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-cfm-house-pressure.xml +561 -563
  396. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-cfm50.xml +561 -563
  397. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-flue.xml +564 -566
  398. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-infil-natural-ach.xml +560 -562
  399. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-overhangs.xml +576 -578
  400. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-rooftypes.xml +589 -591
  401. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-skylights.xml +589 -591
  402. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-level.xml +516 -0
  403. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-split-surfaces.xml +2473 -2493
  404. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-walltypes.xml +753 -755
  405. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-interior-shading.xml +561 -563
  406. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-windows-none.xml +503 -505
  407. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-ambient.xml +497 -497
  408. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-complex.xml +723 -729
  409. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-conditioned-basement-slab-insulation.xml +561 -563
  410. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-conditioned-basement-wall-interior-insulation.xml +561 -563
  411. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-multiple.xml +684 -688
  412. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-slab.xml +515 -517
  413. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-above-grade.xml +608 -610
  414. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-assembly-r.xml +557 -559
  415. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement-wall-insulation.xml +572 -574
  416. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unconditioned-basement.xml +572 -574
  417. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-unvented-crawlspace.xml +572 -574
  418. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-vented-crawlspace.xml +575 -577
  419. data/example_files/resources/hpxml-measures/workflow/sample_files/base-foundation-walkout-basement.xml +626 -628
  420. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-1-speed.xml +563 -562
  421. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-2-speed.xml +560 -562
  422. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-air-to-air-heat-pump-var-speed.xml +560 -562
  423. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-coal-only.xml +519 -521
  424. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-elec-only.xml +519 -521
  425. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-gas-central-ac-1-speed.xml +571 -573
  426. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-gas-only.xml +520 -522
  427. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-oil-only.xml +519 -521
  428. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-propane-only.xml +519 -521
  429. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-boiler-wood-only.xml +519 -521
  430. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-1-speed.xml +550 -549
  431. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-2-speed.xml +547 -549
  432. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-only-var-speed.xml +547 -549
  433. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-central-ac-plus-air-to-air-heat-pump-heating.xml +580 -576
  434. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dse.xml +533 -535
  435. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed-electric.xml +564 -563
  436. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed.xml +564 -563
  437. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-2-speed.xml +561 -563
  438. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-air-to-air-heat-pump-var-speed.xml +561 -563
  439. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-dual-fuel-mini-split-heat-pump-ducted.xml +563 -562
  440. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ducts-leakage-percent.xml +561 -563
  441. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-elec-resistance-only.xml +510 -512
  442. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-furnace-gas.xml +553 -555
  443. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-only-ducted.xml +526 -528
  444. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-evap-cooler-only.xml +506 -505
  445. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-fireplace-wood-only.xml +513 -513
  446. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-fixed-heater-gas-only.xml +563 -563
  447. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-floor-furnace-propane-only.xml +513 -513
  448. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-coal-only.xml +548 -0
  449. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-elec-central-ac-1-speed.xml +561 -563
  450. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-elec-only.xml +547 -549
  451. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-central-ac-2-speed.xml +561 -563
  452. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-central-ac-var-speed.xml +561 -563
  453. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-only.xml +550 -550
  454. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-gas-room-ac.xml +559 -561
  455. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-oil-only.xml +547 -549
  456. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-propane-only.xml +547 -549
  457. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-wood-only.xml +547 -549
  458. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-furnace-x3-dse.xml +577 -579
  459. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ground-to-air-heat-pump.xml +562 -564
  460. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-ideal-air.xml +498 -500
  461. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-air-conditioner-only-ducted.xml +549 -548
  462. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-air-conditioner-only-ductless.xml +512 -511
  463. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted-cooling-only.xml +556 -555
  464. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted-heating-only.xml +562 -561
  465. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ducted.xml +562 -561
  466. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-mini-split-heat-pump-ductless.xml +519 -518
  467. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-multiple.xml +913 -912
  468. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-multiple2.xml +834 -837
  469. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-none.xml +487 -489
  470. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-portable-heater-gas-only.xml +563 -563
  471. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-programmable-thermostat-detailed.xml +566 -0
  472. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-programmable-thermostat.xml +569 -571
  473. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only-33percent.xml +509 -511
  474. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-room-ac-only.xml +509 -511
  475. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-setpoints.xml +561 -563
  476. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-stove-oil-only.xml +513 -513
  477. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-stove-wood-pellets-only.xml +513 -513
  478. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-undersized-allow-increased-fixed-capacities.xml +564 -566
  479. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-undersized.xml +561 -563
  480. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-wall-furnace-elec-only.xml +513 -513
  481. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-ceiling-fans.xml +572 -574
  482. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-detailed.xml +584 -586
  483. data/example_files/resources/hpxml-measures/workflow/sample_files/base-lighting-none.xml +487 -489
  484. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-AMY-2012.xml +561 -563
  485. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-baltimore-md.xml +561 -563
  486. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-dallas-tx.xml +515 -517
  487. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-duluth-mn.xml +561 -563
  488. data/example_files/resources/hpxml-measures/workflow/sample_files/base-location-miami-fl.xml +515 -517
  489. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-balanced.xml +573 -575
  490. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-bath-kitchen-fans.xml +589 -591
  491. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-dse.xml +546 -548
  492. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis-evap-cooler-only-ducted.xml +539 -541
  493. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-cfis.xml +574 -576
  494. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-erv-atre-asre.xml +575 -577
  495. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-erv.xml +575 -577
  496. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-exhaust-rated-flow-rate.xml +573 -575
  497. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-exhaust.xml +573 -575
  498. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-hrv-asre.xml +574 -576
  499. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-hrv.xml +574 -576
  500. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-multiple.xml +793 -795
  501. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-supply.xml +573 -575
  502. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-whole-house-fan.xml +571 -573
  503. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-defaults.xml +476 -495
  504. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-generators.xml +578 -0
  505. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-large-uncommon.xml +753 -833
  506. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-large-uncommon2.xml +740 -820
  507. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-loads-none.xml +549 -559
  508. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-neighbor-shading.xml +574 -576
  509. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-shelter-coefficient.xml +564 -566
  510. data/example_files/resources/hpxml-measures/workflow/sample_files/base-misc-usage-multiplier.xml +723 -725
  511. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv.xml +2 -4
  512. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-stochastic.xml +2 -4
  513. data/example_files/resources/hpxml-measures/workflow/sample_files/base-schedules-user-specified.xml +2 -4
  514. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-calendar-year-custom.xml +562 -564
  515. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-daylight-saving-custom.xml +568 -570
  516. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-daylight-saving-disabled.xml +564 -566
  517. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-runperiod-1-month.xml +565 -567
  518. data/example_files/resources/hpxml-measures/workflow/sample_files/base-simcontrol-timestep-10-mins.xml +561 -563
  519. data/example_files/resources/hpxml-measures/workflow/sample_files/base.xml +561 -563
  520. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-autosize.xml +559 -561
  521. 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 +562 -561
  522. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-air-to-air-heat-pump-1-speed-autosize.xml +559 -558
  523. 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 +559 -561
  524. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-air-to-air-heat-pump-2-speed-autosize.xml +556 -558
  525. 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 +559 -561
  526. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-air-to-air-heat-pump-var-speed-autosize.xml +556 -558
  527. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-boiler-elec-only-autosize.xml +518 -520
  528. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-boiler-gas-central-ac-1-speed-autosize.xml +569 -571
  529. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-boiler-gas-only-autosize.xml +519 -521
  530. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-central-ac-only-1-speed-autosize.xml +549 -548
  531. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-central-ac-only-2-speed-autosize.xml +546 -548
  532. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-central-ac-only-var-speed-autosize.xml +546 -548
  533. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-central-ac-plus-air-to-air-heat-pump-heating-autosize.xml +575 -571
  534. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-dual-fuel-air-to-air-heat-pump-1-speed-autosize.xml +560 -559
  535. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-dual-fuel-mini-split-heat-pump-ducted-autosize.xml +559 -558
  536. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-elec-resistance-only-autosize.xml +509 -511
  537. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-evap-cooler-furnace-gas-autosize.xml +552 -554
  538. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-floor-furnace-propane-only-autosize.xml +512 -512
  539. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-furnace-elec-only-autosize.xml +546 -548
  540. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-furnace-gas-central-ac-2-speed-autosize.xml +559 -561
  541. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-furnace-gas-central-ac-var-speed-autosize.xml +559 -561
  542. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-furnace-gas-only-autosize.xml +549 -549
  543. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-furnace-gas-room-ac-autosize.xml +557 -559
  544. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-ground-to-air-heat-pump-autosize-manual-s-oversize-allowances.xml +562 -564
  545. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-ground-to-air-heat-pump-autosize.xml +559 -561
  546. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-mini-split-air-conditioner-only-ducted-autosize.xml +548 -547
  547. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-autosize-manual-s-oversize-allowances.xml +561 -560
  548. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-autosize.xml +558 -557
  549. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-cooling-only-autosize.xml +553 -552
  550. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-mini-split-heat-pump-ducted-heating-only-autosize.xml +558 -557
  551. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-room-ac-only-autosize.xml +508 -510
  552. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-stove-oil-only-autosize.xml +512 -512
  553. data/example_files/resources/hpxml-measures/workflow/sample_files/hvac_autosizing/base-hvac-wall-furnace-elec-only-autosize.xml +512 -512
  554. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/cfis-with-hydronic-distribution.xml +533 -535
  555. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/clothes-dryer-location.xml +561 -563
  556. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/clothes-washer-location.xml +561 -563
  557. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/cooking-range-location.xml +561 -563
  558. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dhw-frac-load-served.xml +576 -578
  559. data/example_files/resources/hpxml-measures/workflow/sample_files/{base-dhw-uef.xml → invalid_files/dhw-invalid-ef-tank.xml} +3 -5
  560. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dhw-invalid-uef-tank-heat-pump.xml +563 -0
  561. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/dishwasher-location.xml +561 -563
  562. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duct-location-unconditioned-space.xml +561 -563
  563. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duct-location.xml +561 -563
  564. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/duplicate-id.xml +561 -563
  565. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-attic-missing-roof.xml +545 -547
  566. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-basement-missing-exterior-foundation-wall.xml +542 -544
  567. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-basement-missing-slab.xml +545 -545
  568. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-floor-area-exceeds-cfa.xml +562 -0
  569. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-garage-missing-exterior-wall.xml +612 -616
  570. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-garage-missing-roof-ceiling.xml +625 -629
  571. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-garage-missing-slab.xml +609 -611
  572. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-living-missing-ceiling-roof.xml +549 -551
  573. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-living-missing-exterior-wall.xml +471 -473
  574. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/enclosure-living-missing-floor-slab.xml +534 -534
  575. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/heat-pump-mixed-fixed-and-autosize-capacities.xml +561 -560
  576. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/heat-pump-mixed-fixed-and-autosize-capacities2.xml +562 -561
  577. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-distribution-multiple-attached-cooling.xml +913 -912
  578. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-distribution-multiple-attached-heating.xml +913 -912
  579. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-distribution-return-duct-leakage-missing.xml +532 -534
  580. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-dse-multiple-attached-cooling.xml +547 -549
  581. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-dse-multiple-attached-heating.xml +547 -549
  582. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-frac-load-served.xml +913 -912
  583. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/{invalid-calendar-year.xml → hvac-inconsistent-fan-powers.xml} +8 -5
  584. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/hvac-invalid-distribution-system-type.xml +569 -571
  585. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-datatype-boolean.xml +562 -0
  586. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-datatype-float.xml +562 -0
  587. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-datatype-integer.xml +562 -0
  588. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-daylight-saving.xml +568 -567
  589. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-distribution-cfa-served.xml +561 -563
  590. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-epw-filepath.xml +561 -563
  591. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-facility-type-equipment.xml +465 -0
  592. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-facility-type-surfaces.xml +643 -0
  593. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-input-parameters.xml +564 -0
  594. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-neighbor-shading-azimuth.xml +574 -576
  595. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-relatedhvac-desuperheater.xml +552 -551
  596. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-relatedhvac-dhw-indirect.xml +518 -520
  597. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-runperiod.xml +563 -565
  598. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-schema-version.xml +562 -0
  599. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-timestep.xml +561 -563
  600. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-window-height.xml +576 -578
  601. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/lighting-fractions.xml +561 -563
  602. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/missing-duct-location.xml +909 -908
  603. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/missing-elements.xml +559 -561
  604. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-appliance.xml +561 -563
  605. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-duct.xml +561 -563
  606. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-surface.xml +564 -566
  607. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/multifamily-reference-water-heater.xml +561 -563
  608. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/net-area-negative-roof.xml +589 -591
  609. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/net-area-negative-wall.xml +561 -563
  610. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/num-bedrooms-exceeds-limit.xml +562 -0
  611. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/orphaned-hvac-distribution.xml +545 -547
  612. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/refrigerator-location.xml +561 -563
  613. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/refrigerators-multiple-primary.xml +567 -569
  614. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/refrigerators-no-primary.xml +567 -569
  615. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/repeated-relatedhvac-desuperheater.xml +565 -564
  616. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/repeated-relatedhvac-dhw-indirect.xml +527 -529
  617. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/slab-zero-exposed-perimeter.xml +561 -563
  618. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/solar-thermal-system-with-combi-tankless.xml +532 -534
  619. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/solar-thermal-system-with-desuperheater.xml +567 -566
  620. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/solar-thermal-system-with-dhw-indirect.xml +532 -534
  621. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-cfis.xml +574 -576
  622. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-door.xml +561 -563
  623. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-hvac-distribution.xml +561 -563
  624. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-shared-clothes-washer-water-heater.xml +464 -827
  625. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-shared-dishwasher-water-heater.xml +464 -827
  626. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-skylight.xml +589 -591
  627. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-solar-thermal-system.xml +576 -578
  628. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/unattached-window.xml +561 -563
  629. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/water-heater-location-other.xml +561 -563
  630. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/water-heater-location.xml +561 -563
  631. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L100AC.xml +6 -14
  632. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L100AL.xml +6 -14
  633. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L110AC.xml +6 -14
  634. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L110AL.xml +6 -14
  635. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L120AC.xml +6 -14
  636. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L120AL.xml +6 -14
  637. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L130AC.xml +6 -14
  638. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L130AL.xml +6 -14
  639. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L140AC.xml +6 -14
  640. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L140AL.xml +6 -14
  641. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L150AC.xml +6 -14
  642. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L150AL.xml +6 -14
  643. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L155AC.xml +6 -14
  644. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L155AL.xml +6 -14
  645. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L160AC.xml +6 -14
  646. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L160AL.xml +6 -14
  647. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L170AC.xml +6 -14
  648. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L170AL.xml +6 -14
  649. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L200AC.xml +6 -14
  650. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L200AL.xml +6 -14
  651. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L202AC.xml +6 -14
  652. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L202AL.xml +6 -14
  653. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L302XC.xml +6 -16
  654. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L304XC.xml +6 -16
  655. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L322XC.xml +6 -16
  656. data/example_files/resources/hpxml-measures/workflow/tests/ASHRAE_Standard_140/L324XC.xml +6 -16
  657. data/example_files/resources/hpxml-measures/workflow/tests/hpxml_translator_test.rb +277 -224
  658. data/lib/uo_cli/version.rb +1 -1
  659. data/scripts/setup-env-gitbash.sh +4 -4
  660. data/scripts/setup-env.bat +14 -11
  661. data/scripts/setup-env.ps1 +13 -10
  662. data/uo_cli.gemspec +6 -4
  663. metadata +106 -57
  664. data/example_files/resources/hpxml-measures/docs/source/hpxml_to_openstudio.rst +0 -1386
  665. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-shared-laundry-room.xml +0 -828
  666. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-shared-water-heater-recirc.xml +0 -820
  667. data/example_files/resources/hpxml-measures/workflow/sample_files/base-dhw-shared-water-heater.xml +0 -813
  668. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-attached-multifamily.xml +0 -810
  669. data/example_files/resources/hpxml-measures/workflow/sample_files/base-enclosure-common-surfaces.xml +0 -928
  670. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-baseboard.xml +0 -777
  671. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-fan-coil-ducted.xml +0 -808
  672. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-fan-coil.xml +0 -780
  673. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-chiller-water-loop-heat-pump.xml +0 -820
  674. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-cooling-tower-water-loop-heat-pump.xml +0 -815
  675. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-baseboard.xml +0 -760
  676. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-fan-coil-ducted.xml +0 -790
  677. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-fan-coil-eae.xml +0 -759
  678. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-fan-coil.xml +0 -762
  679. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-boiler-only-water-loop-heat-pump.xml +0 -796
  680. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-baseboard.xml +0 -759
  681. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-fan-coil-ducted.xml +0 -789
  682. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-fan-coil.xml +0 -761
  683. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-chiller-only-water-loop-heat-pump.xml +0 -796
  684. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-cooling-tower-only-water-loop-heat-pump.xml +0 -791
  685. data/example_files/resources/hpxml-measures/workflow/sample_files/base-hvac-shared-ground-loop-ground-to-air-heat-pump.xml +0 -814
  686. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-shared-preconditioning.xml +0 -851
  687. data/example_files/resources/hpxml-measures/workflow/sample_files/base-mechvent-shared.xml +0 -835
  688. data/example_files/resources/hpxml-measures/workflow/sample_files/base-pv-shared.xml +0 -827
  689. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/appliances-location-unconditioned-space.xml +0 -564
  690. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/coal-for-non-boiler-heating.xml +0 -514
  691. data/example_files/resources/hpxml-measures/workflow/sample_files/invalid_files/invalid-facility-type.xml +0 -828
@@ -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
@@ -114,15 +114,18 @@ htmlhelp_basename = 'OpenStudio-HPXMLdoc'
114
114
  latex_elements = {
115
115
  # The paper size ('letterpaper' or 'a4paper').
116
116
  #
117
- # 'papersize': 'letterpaper',
117
+ 'papersize': 'letterpaper',
118
118
 
119
119
  # The font size ('10pt', '11pt' or '12pt').
120
120
  #
121
- # 'pointsize': '10pt',
121
+ 'pointsize': '8pt',
122
122
 
123
123
  # Additional stuff for the LaTeX preamble.
124
124
  #
125
- # 'preamble': '',
125
+ 'preamble': '''
126
+ \usepackage[landscape]{geometry}
127
+ \geometry{left=49.5pt, right=49.5pt}
128
+ '''
126
129
 
127
130
  # Latex figure (float) alignment
128
131
  #
@@ -134,7 +137,7 @@ latex_elements = {
134
137
  # author, documentclass [howto, manual, or own class]).
135
138
  latex_documents = [
136
139
  (master_doc, 'OpenStudio-HPXML.tex', u'OpenStudio-HPXML Documentation',
137
- u'Scott Horowitz', 'manual'),
140
+ u'NREL', 'manual'),
138
141
  ]
139
142
 
140
143
 
@@ -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.1.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.1.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
 
@@ -54,4 +54,4 @@ In addition to the standard EnergyPlus outputs found in the run directory, a var
54
54
  Timeseries outputs can also be requested using either the Basic or Advanced approaches.
55
55
  When requested, timeseries outputs will be found in the ``run/results_timeseries.csv`` 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,12 +1,10 @@
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.
@@ -100,6 +98,7 @@ The OpenStudio-HPXML workflow can accommodate the following building features/te
100
98
  - Kitchen/Bath Fans
101
99
  - Whole House Fan
102
100
  - Photovoltaics
101
+ - Generators
103
102
  - Appliances
104
103
 
105
104
  - Clothes Washer
@@ -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,2340 @@
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
+ An increasing number of elements in the HPXML file are being made optional with "smart" defaults.
47
+ Default values, equations, and logic are described throughout this documentation.
48
+
49
+ Most defaults can also be seen by using the ``debug`` argument/flag when running the workflow on an actual HPXML file.
50
+ This will create a new HPXML file (``in.xml`` in the run directory) where additional fields are populated for inspection.
51
+
52
+ For example, suppose a HPXML file has a window defined as follows:
53
+
54
+ .. code-block:: XML
55
+
56
+ <Window>
57
+ <SystemIdentifier id='Window'/>
58
+ <Area>108.0</Area>
59
+ <Azimuth>0</Azimuth>
60
+ <UFactor>0.33</UFactor>
61
+ <SHGC>0.45</SHGC>
62
+ <AttachedToWall idref='Wall'/>
63
+ </Window>
64
+
65
+ In the ``in.xml`` file, the window would have additional elements like so:
66
+
67
+ .. code-block:: XML
68
+
69
+ <Window>
70
+ <SystemIdentifier id='Window'/>
71
+ <Area>108.0</Area>
72
+ <Azimuth>0</Azimuth>
73
+ <UFactor>0.33</UFactor>
74
+ <SHGC>0.45</SHGC>
75
+ <InteriorShading>
76
+ <SystemIdentifier id='WindowInteriorShading'/>
77
+ <SummerShadingCoefficient>0.7</SummerShadingCoefficient>
78
+ <WinterShadingCoefficient>0.85</WinterShadingCoefficient>
79
+ </InteriorShading>
80
+ <FractionOperable>0.67</FractionOperable>
81
+ <AttachedToWall idref='Wall'/>
82
+ </Window>
83
+
84
+ .. note::
85
+
86
+ The OpenStudio-HPXML workflow generally treats missing HPXML objects differently than missing properties.
87
+ For example, if there is a ``Window`` with no ``Overhangs`` object defined, the window will be interpreted as having no overhangs and modeled this way.
88
+ On the other hand, if there is a ``Window`` element with no ``FractionOperable`` property defined, it is assumed that the operable property of the window is unknown and will be defaulted in the model according to :ref:`windowinputs`.
89
+
90
+ HPXML Software Info
91
+ -------------------
92
+
93
+ High-level simulation inputs are entered in ``/HPXML/SoftwareInfo``.
94
+
95
+ HPXML Simulation Control
96
+ ************************
97
+
98
+ EnergyPlus simulation controls are entered in ``/HPXML/SoftwareInfo/extension/SimulationControl``.
99
+
100
+ ================================== ======== ======= ============= ======== =========================== =====================================
101
+ Element Type Units Constraints Required Default Description
102
+ ================================== ======== ======= ============= ======== =========================== =====================================
103
+ ``Timestep`` integer minutes Divisor of 60 No 60 (1 hour) Timestep
104
+ ``BeginMonth`` integer 1-12 [#]_ No 1 (January) Run period start date
105
+ ``BeginDayOfMonth`` integer 1-31 No 1 Run period start date
106
+ ``EndMonth`` integer 1-12 No 12 (December) Run period end date
107
+ ``EndDayOfMonth`` integer 1-31 No Run period end date
108
+ ``CalendarYear`` integer > 1600 No 2007 (for TMY weather) [#]_ Calendar year (for start day of week)
109
+ ``DaylightSaving/Enabled`` boolean No true Daylight savings enabled?
110
+ ================================== ======== ======= ============= ======== =========================== =====================================
111
+
112
+ .. [#] BeginMonth/BeginDayOfMonth date must occur before EndMonth/EndDayOfMonth date (e.g., a run period from 10/1 to 3/31 is invalid).
113
+ .. [#] 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.
114
+
115
+ If daylight saving is enabled, additional information is specified in ``DaylightSaving``.
116
+
117
+ ====================================== ======== ===== ============= ======== ============================= ===========
118
+ Element Type Units Constraints Required Default Description
119
+ ====================================== ======== ===== ============= ======== ============================= ===========
120
+ ``BeginMonth`` and ``BeginDayOfMonth`` integer 1-12 and 1-31 No EPW else 3/12 (March 12) [#]_ Start date
121
+ ``EndMonth`` and ``EndDayOfMonth`` integer 1-12 and 1-31 No EPW else 11/5 (November 5) End date
122
+ ====================================== ======== ===== ============= ======== ============================= ===========
123
+
124
+ .. [#] Daylight savings dates will be defined according to the EPW weather file header; if not available, fallback default values listed above will be used.
125
+
126
+ HPXML HVAC Sizing Control
127
+ *************************
128
+
129
+ HVAC equipment sizing controls are entered in ``/HPXML/SoftwareInfo/extension/HVACSizingControl``.
130
+
131
+ ================================= ======== ===== =========== ======== ======= ============================================
132
+ Element Type Units Constraints Required Default Description
133
+ ================================= ======== ===== =========== ======== ======= ============================================
134
+ ``AllowIncreasedFixedCapacities`` boolean No false Logic for fixed capacity HVAC equipment [#]_
135
+ ``UseMaxLoadForHeatPumps`` boolean No true Logic for autosized heat pumps [#]_
136
+ ================================= ======== ===== =========== ======== ======= ============================================
137
+
138
+ .. [#] 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.
139
+ .. [#] 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.
140
+
141
+ HPXML Building Summary
142
+ ----------------------
143
+
144
+ High-level building summary information is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary``.
145
+
146
+ HPXML Site
147
+ **********
148
+
149
+ Building site information is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/Site``.
150
+
151
+ ================================ ======== ===== =========== ======== ======== ============================================================
152
+ Element Type Units Constraints Required Default Notes
153
+ ================================ ======== ===== =========== ======== ======== ============================================================
154
+ ``SiteType`` string See [#]_ No suburban Terrain type for infiltration model
155
+ ``extension/ShelterCoefficient`` double 0-1 No 0.5 [#]_ Nearby buildings, trees, obstructions for infiltration model
156
+ ``extension/Neighbors`` element >= 0 No <none> Presence of neighboring buildings for solar shading
157
+ ================================ ======== ===== =========== ======== ======== ============================================================
158
+
159
+ .. [#] SiteType choices are "rural", "suburban", or "urban".
160
+ .. [#] ShelterCoefficient values are described as follows:
161
+
162
+ - **1.0**: No obstructions or local shielding;
163
+ - **0.9**: Light local shielding with few obstructions within two building heights;
164
+ - **0.7**: Local shielding with many large obstructions within two building heights;
165
+ - **0.5**: Heavily shielded, many large obstructions within one building height;
166
+ - **0.3**: Complete shielding with large buildings immediately adjacent.
167
+
168
+ For each neighboring building defined, additional information is entered in a ``extension/Neighbors/NeighborBuilding``.
169
+
170
+ ============ ======== ======= =========== ======== ======== =============================================
171
+ Element Type Units Constraints Required Default Notes
172
+ ============ ======== ======= =========== ======== ======== =============================================
173
+ ``Azimuth`` integer deg 0-359 Yes Direction of neighbors (clockwise from North)
174
+ ``Distance`` double ft > 0 Yes Distance of neighbor from the dwelling unit
175
+ ``Height`` double ft > 0 No See [#]_ Height of neighbor
176
+ ============ ======== ======= =========== ======== ======== =============================================
177
+
178
+ .. [#] If Height not provided, assumed to be same height as the dwelling unit.
179
+
180
+ HPXML Building Occupancy
181
+ ************************
182
+
183
+ Building occupancy is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/BuildingOccupancy``.
184
+
185
+ ===================== ======== ===== =========== ======== ==================== ========================
186
+ Element Type Units Constraints Required Default Notes
187
+ ===================== ======== ===== =========== ======== ==================== ========================
188
+ ``NumberofResidents`` integer >= 0 No <number of bedrooms> Number of occupants [#]_
189
+ ===================== ======== ===== =========== ======== ==================== ========================
190
+
191
+ .. [#] NumberofResidents is only used for occupant heat gain.
192
+ Most occupancy assumptions (e.g., usage of plug loads, appliances, hot water, etc.) are driven by the number of bedrooms, not number of occupants.
193
+
194
+ HPXML Building Construction
195
+ ***************************
196
+
197
+ Building construction is entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/BuildingConstruction``.
198
+
199
+ ========================================================= ======== ========= =========== ======== ======== =======================================================================
200
+ Element Type Units Constraints Required Default Notes
201
+ ========================================================= ======== ========= =========== ======== ======== =======================================================================
202
+ ``ResidentialFacilityType`` string See [#]_ Yes Type of dwelling unit
203
+ ``NumberofConditionedFloors`` double > 0 Yes Number of conditioned floors (including a basement)
204
+ ``NumberofConditionedFloorsAboveGrade`` double > 0 Yes Number of conditioned floors above grade (including a walkout basement)
205
+ ``NumberofBedrooms`` integer > 0 Yes Number of bedrooms [#]_
206
+ ``NumberofBathrooms`` integer > 0 No See [#]_ Number of bathrooms
207
+ ``ConditionedFloorArea`` double ft2 > 0 Yes Floor area within conditioned space boundary
208
+ ``ConditionedBuildingVolume`` or ``AverageCeilingHeight`` double ft3 or ft > 0 No See [#]_ Volume/ceiling height within conditioned space boundary
209
+ ``extension/HasFlueOrChimney`` boolean No See [#]_ Presence of flue or chimney for infiltration model
210
+ ========================================================= ======== ========= =========== ======== ======== =======================================================================
211
+
212
+ .. [#] ResidentialFacilityType choices are "single-family detached", "single-family attached", "apartment unit", or "manufactured home".
213
+ .. [#] NumberofBedrooms is currently used to determine usage of plug loads, appliances, hot water, etc.
214
+ .. [#] 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>`_.
215
+ .. [#] If neither ConditionedBuildingVolume nor AverageCeilingHeight provided, AverageCeilingHeight defaults to 8.0.
216
+ If needed, additional defaulting is performed using the following relationship: ConditionedBuildingVolume = ConditionedFloorArea * AverageCeilingHeight.
217
+ .. [#] If HasFlueOrChimney not provided, assumed to be true if any of the following conditions are met:
218
+
219
+ - heating system is non-electric Furnace, Boiler, WallFurnace, FloorFurnace, Stove, PortableHeater, or FixedHeater and AFUE/Percent is less than 0.89,
220
+ - heating system is non-electric Fireplace, or
221
+ - water heater is non-electric with energy factor (or equivalent calculated from uniform energy factor) less than 0.63.
222
+
223
+ HPXML Weather Station
224
+ ---------------------
225
+
226
+ Weather information is entered in ``/HPXML/Building/BuildingDetails/ClimateandRiskZones/WeatherStation``.
227
+
228
+ ========================= ====== ======= =========== ======== ======= ==============================================
229
+ Element Type Units Constraints Required Default Notes
230
+ ========================= ====== ======= =========== ======== ======= ==============================================
231
+ ``SystemIdentifier`` id Yes Unique identifier
232
+ ``Name`` string Yes Name of weather station
233
+ ``extension/EPWFilePath`` string Yes Path to the EnergyPlus weather file (EPW) [#]_
234
+ ========================= ====== ======= =========== ======== ======= ==============================================
235
+
236
+ .. [#] A full set of U.S. TMY3 weather files can be `downloaded here <https://data.nrel.gov/system/files/128/tmy3s-cache-csv.zip>`_.
237
+
238
+ HPXML Enclosure
239
+ ---------------
240
+
241
+ The dwelling unit's enclosure is entered in ``/HPXML/Building/BuildingDetails/Enclosure``.
242
+
243
+ 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.
244
+ 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.
245
+ 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.
246
+
247
+ Interior partition surfaces (e.g., walls between rooms inside conditioned space, or the floor between two conditioned stories) can be excluded.
248
+
249
+ 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.
250
+ 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"``.
251
+
252
+ .. warning::
253
+
254
+ It is the software tool's responsibility to provide the appropriate building surfaces.
255
+ While some error-checking is in place, it is not possible to know whether some surfaces are incorrectly missing.
256
+
257
+ Also note that wall and roof surfaces do not require an azimuth to be specified.
258
+ Rather, only the windows/skylights themselves require an azimuth.
259
+ 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.
260
+
261
+ HPXML Air Infiltration
262
+ **********************
263
+
264
+ Building air leakage is entered in ``/HPXML/Building/BuildingDetails/Enclosure/AirInfiltration/AirInfiltrationMeasurement``.
265
+
266
+ ==================================== ====== ===== =========== ========= ================= ========================================================
267
+ Element Type Units Constraints Required Default Notes
268
+ ==================================== ====== ===== =========== ========= ================= ========================================================
269
+ ``SystemIdentifier`` id Yes Unique identifier
270
+ ``BuildingAirLeakage/UnitofMeasure`` string See [#]_ Yes Units for air leakage
271
+ ``HousePressure`` double Pa > 0 See [#]_ House pressure with respect to outside, typically ~50 Pa
272
+ ``BuildingAirLeakage/AirLeakage`` double > 0 Yes Value for air leakage
273
+ ``InfiltrationVolume`` double ft3 > 0 No ConditionedVolume Volume associated with the air leakage measurement
274
+ ==================================== ====== ===== =========== ========= ================= ========================================================
275
+
276
+ .. [#] 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).
277
+ .. [#] HousePressure only required if BuildingAirLeakage/UnitofMeasure is not "ACHnatural".
278
+
279
+ HPXML Attics
280
+ ************
281
+
282
+ 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``.
283
+
284
+ ================= ====== ===== =========== ======== ========== ==========================
285
+ Element Type Units Constraints Required Default Notes
286
+ ================= ====== ===== =========== ======== ========== ==========================
287
+ ``UnitofMeasure`` string See [#]_ No SLA Units for ventilation rate
288
+ ``Value`` double > 0 No 1/300 [#]_ Value for ventilation rate
289
+ ================= ====== ===== =========== ======== ========== ==========================
290
+
291
+ .. [#] UnitofMeasure choices are "SLA" (specific leakage area) or "ACHnatural" (natural air changes per hour).
292
+ .. [#] Value default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
293
+
294
+ HPXML Foundations
295
+ *****************
296
+
297
+ 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``.
298
+
299
+ ================= ====== ===== =========== ======== ========== ==========================
300
+ Element Type Units Constraints Required Default Notes
301
+ ================= ====== ===== =========== ======== ========== ==========================
302
+ ``UnitofMeasure`` string See [#]_ No SLA Units for ventilation rate
303
+ ``Value`` double > 0 No 1/150 [#]_ Value for ventilation rate
304
+ ================= ====== ===== =========== ======== ========== ==========================
305
+
306
+ .. [#] UnitofMeasure only choice is "SLA" (specific leakage area).
307
+ .. [#] Value default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
308
+
309
+ HPXML Roofs
310
+ ***********
311
+
312
+ Each pitched or flat roof surface that is exposed to ambient conditions is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Roofs/Roof``.
313
+
314
+ 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``.
315
+
316
+ ====================================== ================ ============ =============== ========= ============================== ==================================
317
+ Element Type Units Constraints Required Default Notes
318
+ ====================================== ================ ============ =============== ========= ============================== ==================================
319
+ ``SystemIdentifier`` id Yes Unique identifier
320
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
321
+ ``Area`` double ft2 > 0 Yes Gross area (including skylights)
322
+ ``Azimuth`` integer deg 0-359 No See [#]_ Azimuth (clockwise from North)
323
+ ``RoofType`` string See [#]_ No asphalt or fiberglass shingles Roof type
324
+ ``SolarAbsorptance`` or ``RoofColor`` double or string 0-1 or See [#]_ Yes See [#]_ Solar absorptance or color
325
+ ``Emittance`` double 0-1 No 0.90 Emittance
326
+ ``Pitch`` integer ?:12 >= 0 Yes Pitch
327
+ ``RadiantBarrier`` boolean No false Presence of radiant barrier
328
+ ``RadiantBarrier/RadiantBarrierGrade`` integer 1-3 See [#]_ Radiant barrier installation grade
329
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
330
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
331
+ ====================================== ================ ============ =============== ========= ============================== ==================================
332
+
333
+ .. [#] InteriorAdjacentTo choices are "attic - vented", "attic - unvented", "living space", or "garage".
334
+ See :ref:`hpxmllocations` for descriptions.
335
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
336
+ .. [#] RoofType choices are "asphalt or fiberglass shingles", "wood shingles or shakes", "slate or tile shingles", or "metal surfacing".
337
+ .. [#] RoofColor choices are "light", "medium", "medium dark", "dark", or "reflective".
338
+ .. [#] If SolarAbsorptance not provided, defaults based on RoofColor/RoofType:
339
+
340
+ - **asphalt or fiberglass shingles**: dark=0.92, medium dark=0.89, medium=0.85, light=0.75, reflective=0.50
341
+ - **wood shingles or shakes**: dark=0.92, medium dark=0.89, medium=0.85, light=0.75, reflective=0.50
342
+ - **slate or tile shingles**: dark=0.90, medium dark=0.83, medium=0.75, light=0.60, reflective=0.30
343
+ - **metal surfacing**: dark=0.90, medium dark=0.83, medium=0.75, light=0.60, reflective=0.30
344
+
345
+ .. [#] RadiantBarrierGrade only required if RadiantBarrier is provided.
346
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
347
+
348
+ HPXML Rim Joists
349
+ ****************
350
+
351
+ 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``.
352
+
353
+ ====================================== ================ ============ =============== ======== =========== ==============================
354
+ Element Type Units Constraints Required Default Notes
355
+ ====================================== ================ ============ =============== ======== =========== ==============================
356
+ ``SystemIdentifier`` id Yes Unique identifier
357
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type
358
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
359
+ ``Area`` double ft2 > 0 Yes Gross area
360
+ ``Azimuth`` integer deg 0-359 No See [#]_ Azimuth (clockwise from North)
361
+ ``Siding`` string See [#]_ No wood siding Siding material
362
+ ``SolarAbsorptance`` or ``Color`` double or string 0-1 or See [#]_ Yes See [#]_ Solar absorptance or color
363
+ ``Emittance`` double 0-1 No 0.90 Emittance
364
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
365
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
366
+ ====================================== ================ ============ =============== ======== =========== ==============================
367
+
368
+ .. [#] 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".
369
+ See :ref:`hpxmllocations` for descriptions.
370
+ .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
371
+ See :ref:`hpxmllocations` for descriptions.
372
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
373
+ .. [#] Siding choices are "wood siding", "vinyl siding", "stucco", "fiber cement siding", "brick veneer", or "aluminum siding".
374
+ .. [#] Color choices are "light", "medium", "medium dark", "dark", or "reflective".
375
+ .. [#] If SolarAbsorptance not provided, defaults based on Color:
376
+
377
+ - **dark**: 0.95
378
+ - **medium dark**: 0.85
379
+ - **medium**: 0.70
380
+ - **light**: 0.50
381
+ - **reflective**: 0.30
382
+
383
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
384
+
385
+ HPXML Walls
386
+ ***********
387
+
388
+ Each wall that has no contact with the ground and bounds a space type is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Walls/Wall``.
389
+
390
+ ====================================== ================ ============ =============== ============= =========== ====================================
391
+ Element Type Units Constraints Required Default Notes
392
+ ====================================== ================ ============ =============== ============= =========== ====================================
393
+ ``SystemIdentifier`` id Yes Unique identifier
394
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type
395
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
396
+ ``WallType`` element 1 [#]_ Yes Wall type (for thermal mass)
397
+ ``Area`` double ft2 > 0 Yes Gross area (including doors/windows)
398
+ ``Azimuth`` integer deg 0-359 No See [#]_ Azimuth (clockwise from North)
399
+ ``Siding`` string See [#]_ No wood siding Siding material
400
+ ``SolarAbsorptance`` or ``Color`` double or string 0-1 or See [#]_ Yes See [#]_ Solar absorptance or color
401
+ ``Emittance`` double 0-1 No 0.90 Emittance
402
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
403
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
404
+ ====================================== ================ ============ =============== ============= =========== ====================================
405
+
406
+ .. [#] 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".
407
+ See :ref:`hpxmllocations` for descriptions.
408
+ .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
409
+ See :ref:`hpxmllocations` for descriptions.
410
+ .. [#] WallType child element choices are ``WoodStud``, ``DoubleWoodStud``, ``ConcreteMasonryUnit``, ``StructurallyInsulatedPanel``, ``InsulatedConcreteForms``, ``SteelFrame``, ``SolidConcrete``, ``StructuralBrick``, ``StrawBale``, ``Stone``, ``LogWall``, or ``Adobe``.
411
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
412
+ .. [#] Siding choices are "wood siding", "vinyl siding", "stucco", "fiber cement siding", "brick veneer", or "aluminum siding".
413
+ .. [#] Color choices are "light", "medium", "medium dark", "dark", or "reflective".
414
+ .. [#] If SolarAbsorptance not provided, defaults based on Color:
415
+
416
+ - **dark**: 0.95
417
+ - **medium dark**: 0.85
418
+ - **medium**: 0.70
419
+ - **light**: 0.50
420
+ - **reflective**: 0.30
421
+
422
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
423
+
424
+ HPXML Foundation Walls
425
+ **********************
426
+
427
+ Each wall that is in contact with the ground should be specified as an ``/HPXML/Building/BuildingDetails/Enclosure/FoundationWalls/FoundationWall``.
428
+
429
+ 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``.
430
+
431
+ ============================================================== ======== ============ =========== ========= ======== ====================================
432
+ Element Type Units Constraints Required Default Notes
433
+ ============================================================== ======== ============ =========== ========= ======== ====================================
434
+ ``SystemIdentifier`` id Yes Unique identifier
435
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type [#]_
436
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
437
+ ``Height`` double ft > 0 Yes Total height
438
+ ``Area`` double ft2 > 0 Yes Gross area (including doors/windows)
439
+ ``Azimuth`` integer deg 0-359 No See [#]_ Azimuth (clockwise from North)
440
+ ``Thickness`` double inches > 0 No 8.0 Thickness excluding interior framing
441
+ ``DepthBelowGrade`` double ft >= 0 Yes Depth below grade [#]_
442
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
443
+ ``Insulation/Layer[InstallationType="continuous - interior"]`` element 0-1 See [#]_ Interior insulation layer
444
+ ``Insulation/Layer[InstallationType="continuous - exterior"]`` element 0-1 See [#]_ Exterior insulation layer
445
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 See [#]_ Assembly R-value [#]_
446
+ ============================================================== ======== ============ =========== ========= ======== ====================================
447
+
448
+ .. [#] 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".
449
+ See :ref:`hpxmllocations` for descriptions.
450
+ .. [#] InteriorAdjacentTo choices are "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
451
+ See :ref:`hpxmllocations` for descriptions.
452
+ .. [#] 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.
453
+ .. [#] If Azimuth not provided, modeled as four surfaces of equal area facing every direction.
454
+ .. [#] For exterior foundation walls, depth below grade is relative to the ground plane.
455
+ For interior foundation walls, depth below grade is the vertical span of foundation wall in contact with the ground.
456
+ 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.
457
+ 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.
458
+ .. [#] Layer[InstallationType="continuous - interior"] only required if AssemblyEffectiveRValue is not provided.
459
+ .. [#] Layer[InstallationType="continuous - exterior"] only required if AssemblyEffectiveRValue is not provided.
460
+ .. [#] AssemblyEffectiveRValue only required if Layer elements are not provided.
461
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior air film, and insulation installation grade.
462
+ R-value should **not** include exterior air film (for any above-grade exposure) or any soil thermal resistance.
463
+
464
+ If insulation layers are provided, additional information is entered in each ``FoundationWall/Insulation/Layer``.
465
+
466
+ ========================================== ======== ============ =========== ======== ======= ======================================================================
467
+ Element Type Units Constraints Required Default Notes
468
+ ========================================== ======== ============ =========== ======== ======= ======================================================================
469
+ ``NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of the foundation wall insulation; use zero if no insulation
470
+ ``extension/DistanceToTopOfInsulation`` double ft >= 0 Yes Vertical distance from top of foundation wall to top of insulation
471
+ ``extension/DistanceToBottomOfInsulation`` double ft >= 0 Yes Vertical distance from top of foundation wall to bottom of insulation
472
+ ========================================== ======== ============ =========== ======== ======= ======================================================================
473
+
474
+ HPXML Frame Floors
475
+ ******************
476
+
477
+ 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``.
478
+
479
+ ====================================== ======== ============ =========== ======== ======= ============================
480
+ Element Type Units Constraints Required Default Notes
481
+ ====================================== ======== ============ =========== ======== ======= ============================
482
+ ``SystemIdentifier`` id Yes Unique identifier
483
+ ``ExteriorAdjacentTo`` string See [#]_ Yes Exterior adjacent space type
484
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
485
+ ``Area`` double ft2 > 0 Yes Gross area
486
+ ``Insulation/SystemIdentifier`` id Yes Unique identifier
487
+ ``Insulation/AssemblyEffectiveRValue`` double F-ft2-hr/Btu > 0 Yes Assembly R-value [#]_
488
+ ====================================== ======== ============ =========== ======== ======= ============================
489
+
490
+ .. [#] 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".
491
+ See :ref:`hpxmllocations` for descriptions.
492
+ .. [#] InteriorAdjacentTo choices are "living space", "attic - vented", "attic - unvented", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
493
+ See :ref:`hpxmllocations` for descriptions.
494
+ .. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
495
+
496
+ 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``.
497
+
498
+ ====================================== ======== ===== ============== ======== ======= ==========================================
499
+ Element Type Units Constraints Required Default Notes
500
+ ====================================== ======== ===== ============== ======== ======= ==========================================
501
+ ``extension/OtherSpaceAboveOrBelow`` string See [#]_ Yes Specifies if above/below the MF space type
502
+ ====================================== ======== ===== ============== ======== ======= ==========================================
503
+
504
+ .. [#] OtherSpaceAboveOrBelow choices are "above" or "below".
505
+
506
+ HPXML Slabs
507
+ ***********
508
+
509
+ 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``.
510
+
511
+ =========================================== ======== ============ =========== ========= ======== ====================================================
512
+ Element Type Units Constraints Required Default Notes
513
+ =========================================== ======== ============ =========== ========= ======== ====================================================
514
+ ``SystemIdentifier`` id Yes Unique identifier
515
+ ``InteriorAdjacentTo`` string See [#]_ Yes Interior adjacent space type
516
+ ``Area`` double ft2 > 0 Yes Gross area
517
+ ``Thickness`` double inches >= 0 No See [#]_ Thickness [#]_
518
+ ``ExposedPerimeter`` double ft > 0 Yes Perimeter exposed to ambient conditions [#]_
519
+ ``PerimeterInsulationDepth`` double ft >= 0 Yes Depth from grade to bottom of vertical insulation
520
+ ``UnderSlabInsulationWidth`` double ft >= 0 See [#]_ Width from slab edge inward of horizontal insulation
521
+ ``UnderSlabInsulationSpansEntireSlab`` boolean See [#]_ Whether horizontal insulation spans entire slab
522
+ ``DepthBelowGrade`` double ft >= 0 See [#]_ Depth from the top of the slab surface to grade
523
+ ``PerimeterInsulation/SystemIdentifier`` id Yes Unique identifier
524
+ ``PerimeterInsulation/Layer/NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of vertical insulation
525
+ ``UnderSlabInsulation/SystemIdentifier`` id Yes Unique identifier
526
+ ``UnderSlabInsulation/Layer/NominalRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of horizontal insulation
527
+ ``extension/CarpetFraction`` double frac 0-1 No See [#]_ Fraction of slab covered by carpet
528
+ ``extension/CarpetRValue`` double F-ft2-hr/Btu >= 0 No See [#]_ Carpet R-value
529
+ =========================================== ======== ============ =========== ========= ======== ====================================================
530
+
531
+ .. [#] InteriorAdjacentTo choices are "living space", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", or "garage".
532
+ See :ref:`hpxmllocations` for descriptions.
533
+ .. [#] If Thickness not provided, defaults to 0 when adjacent to crawlspace and 4 inches for all other cases.
534
+ .. [#] For a crawlspace with a dirt floor, enter a thickness of zero.
535
+ .. [#] ExposedPerimeter includes any slab length that falls along the perimeter of the building's footprint (i.e., is exposed to ambient conditions).
536
+ So a basement slab edge adjacent to a garage or crawlspace, for example, should not be included.
537
+ .. [#] UnderSlabInsulationWidth only required if UnderSlabInsulationSpansEntireSlab=true is not provided.
538
+ .. [#] UnderSlabInsulationSpansEntireSlab=true only required if UnderSlabInsulationWidth is not provided.
539
+ .. [#] DepthBelowGrade only required if the attached foundation has no ``FoundationWalls``.
540
+ For foundation types with walls, the the slab's position relative to grade is determined by the ``FoundationWall/DepthBelowGrade`` value.
541
+ .. [#] If CarpetFraction not provided, defaults to 0.8 when adjacent to conditioned space, otherwise 0.0.
542
+ .. [#] If CarpetRValue not provided, defaults to 2.0 when adjacent to conditioned space, otherwise 0.0.
543
+
544
+ .. _windowinputs:
545
+
546
+ HPXML Windows
547
+ *************
548
+
549
+ Each window or glass door area is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Windows/Window``.
550
+
551
+ ============================================ ======== ============ =========== ======== ========= ==============================================
552
+ Element Type Units Constraints Required Default Notes
553
+ ============================================ ======== ============ =========== ======== ========= ==============================================
554
+ ``SystemIdentifier`` id Yes Unique identifier
555
+ ``Area`` double ft2 > 0 Yes Total area
556
+ ``Azimuth`` integer deg 0-359 Yes Azimuth (clockwise from North)
557
+ ``UFactor`` double Btu/F-ft2-hr > 0 Yes Full-assembly NFRC U-factor
558
+ ``SHGC`` double 0-1 Yes Full-assembly NFRC solar heat gain coefficient
559
+ ``InteriorShading/SummerShadingCoefficient`` double frac 0-1 No 0.70 [#]_ Summer interior shading coefficient
560
+ ``InteriorShading/WinterShadingCoefficient`` double frac 0-1 No 0.85 [#]_ Winter interior shading coefficient
561
+ ``Overhangs`` element 0-1 No <none> Presence of overhangs (including roof eaves)
562
+ ``FractionOperable`` double frac 0-1 No 0.67 Operable fraction [#]_
563
+ ``AttachedToWall`` idref See [#]_ Yes ID of attached wall
564
+ ============================================ ======== ============ =========== ======== ========= ==============================================
565
+
566
+ .. [#] SummerShadingCoefficient default value indicates 30% reduction in solar heat gain, based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
567
+ .. [#] WinterShadingCoefficient default value indicates 15% reduction in solar heat gain, based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
568
+ .. [#] FractionOperable reflects whether the windows are operable (can be opened), not how they are used by the occupants.
569
+ If a ``Window`` represents a single window, the value should be 0 or 1.
570
+ 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).
571
+ 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.
572
+ .. [#] AttachedToWall must reference a ``Wall`` or ``FoundationWall``.
573
+
574
+ If overhangs are specified, additional information is entered in ``Overhangs``.
575
+
576
+ ============================ ======== ====== =========== ======== ======= ========================================================
577
+ Element Type Units Constraints Required Default Notes
578
+ ============================ ======== ====== =========== ======== ======= ========================================================
579
+ ``Depth`` double inches > 0 Yes Depth of overhang
580
+ ``DistanceToTopOfWindow`` double ft >= 0 Yes Vertical distance from overhang to top of window
581
+ ``DistanceToBottomOfWindow`` double ft >= 0 Yes Vertical distance from overhang to bottom of window [#]_
582
+ ============================ ======== ====== =========== ======== ======= ========================================================
583
+
584
+ .. [#] The difference between DistanceToBottomOfWindow and DistanceToTopOfWindow defines the height of the window.
585
+
586
+ HPXML Skylights
587
+ ***************
588
+
589
+ Each skylight is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Skylights/Skylight``.
590
+
591
+ ============================================ ======== ============ =========== ======== ========= ==============================================
592
+ Element Type Units Constraints Required Default Notes
593
+ ============================================ ======== ============ =========== ======== ========= ==============================================
594
+ ``SystemIdentifier`` id Yes Unique identifier
595
+ ``Area`` double ft2 > 0 Yes Total area
596
+ ``Azimuth`` integer deg 0-359 Yes Azimuth (clockwise from North)
597
+ ``UFactor`` double Btu/F-ft2-hr > 0 Yes Full-assembly NFRC U-factor
598
+ ``SHGC`` double 0-1 Yes Full-assembly NFRC solar heat gain coefficient
599
+ ``InteriorShading/SummerShadingCoefficient`` double frac 0-1 No 1.0 [#]_ Summer interior shading coefficient
600
+ ``InteriorShading/WinterShadingCoefficient`` double frac 0-1 No 1.0 [#]_ Winter interior shading coefficient
601
+ ``AttachedToRoof`` idref See [#]_ Yes ID of attached roof
602
+ ============================================ ======== ============ =========== ======== ========= ==============================================
603
+
604
+ .. [#] SummerShadingCoefficient default value indicates 0% reduction in solar heat gain.
605
+ .. [#] WinterShadingCoefficient default value indicates 0% reduction in solar heat gain.
606
+ .. [#] AttachedToRoof must reference a ``Roof``.
607
+
608
+ HPXML Doors
609
+ ***********
610
+
611
+ Each opaque door is entered as an ``/HPXML/Building/BuildingDetails/Enclosure/Doors/Door``.
612
+
613
+ ============================================ ======== ============ =========== ======== ========= ==============================
614
+ Element Type Units Constraints Required Default Notes
615
+ ============================================ ======== ============ =========== ======== ========= ==============================
616
+ ``SystemIdentifier`` id Yes Unique identifier
617
+ ``AttachedToWall`` idref See [#]_ Yes ID of attached wall
618
+ ``Area`` double ft2 > 0 Yes Total area
619
+ ``Azimuth`` integer deg 0-359 Yes Azimuth (clockwise from North)
620
+ ``RValue`` double F-ft2-hr/Btu > 0 Yes R-value
621
+ ============================================ ======== ============ =========== ======== ========= ==============================
622
+
623
+ .. [#] AttachedToWall must reference a ``Wall`` or ``FoundationWall``.
624
+
625
+ HPXML Systems
626
+ -------------
627
+
628
+ The dwelling unit's systems are entered in ``/HPXML/Building/BuildingDetails/Systems``.
629
+
630
+ .. _hvac_heating:
631
+
632
+ HPXML Heating Systems
633
+ *********************
634
+
635
+ Each heating system (other than heat pumps) is entered as an ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/HeatingSystem``.
636
+
637
+ ================================= ======== ====== =========== ======== ========= ===============================
638
+ Element Type Units Constraints Required Default Notes
639
+ ================================= ======== ====== =========== ======== ========= ===============================
640
+ ``SystemIdentifier`` id Yes Unique identifier
641
+ ``HeatingSystemType`` element 1 [#]_ Yes Type of heating system
642
+ ``FractionHeatLoadServed`` double frac 0-1 [#]_ Yes Fraction of heating load served
643
+ ``HeatingSystemFuel`` string See [#]_ Yes Fuel type
644
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Input heating capacity
645
+ ================================= ======== ====== =========== ======== ========= ===============================
646
+
647
+ .. [#] HeatingSystemType child element choices are ``ElectricResistance``, ``Furnace``, ``WallFurnace``, ``FloorFurnace``, ``Boiler``, ``Stove``, ``PortableHeater``, ``FixedHeater``, or ``Fireplace``.
648
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
649
+ For example, the dwelling unit could have a boiler heating system and a heat pump with values of 0.4 (40%) and 0.6 (60%), respectively.
650
+ .. [#] 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".
651
+ For ``ElectricResistance``, "electricity" is required.
652
+
653
+ Electric Resistance
654
+ ~~~~~~~~~~~~~~~~~~~
655
+
656
+ If electric resistance heating is specified, additional information is entered in ``HeatingSystem``.
657
+
658
+ ================================================== ====== ===== =========== ======== ======= ==========
659
+ Element Type Units Constraints Required Default Notes
660
+ ================================================== ====== ===== =========== ======== ======= ==========
661
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0-1 Yes Efficiency
662
+ ================================================== ====== ===== =========== ======== ======= ==========
663
+
664
+ Furnace
665
+ ~~~~~~~
666
+
667
+ If a furnace is specified, additional information is entered in ``HeatingSystem``.
668
+
669
+ =============================================== ====== ===== =========== ======== ========= ==================================
670
+ Element Type Units Constraints Required Default Notes
671
+ =============================================== ====== ===== =========== ======== ========= ==================================
672
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
673
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0-1 Yes Rated efficiency
674
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Installed fan efficiency
675
+ =============================================== ====== ===== =========== ======== ========= ==================================
676
+
677
+ .. [#] HVACDistribution type must be AirDistribution or DSE.
678
+ .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.5 W/cfm if AFUE <= 0.9, else 0.375 W/cfm.
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 Installed fan power
690
+ =============================================== ====== ===== =========== ======== ======= ===================
691
+
692
+ Boiler
693
+ ~~~~~~
694
+
695
+ If a boiler is specified, additional information is entered in ``HeatingSystem``.
696
+
697
+ ========================================================================== ======== ====== =========== ======== ======== =========================================
698
+ Element Type Units Constraints Required Default Notes
699
+ ========================================================================== ======== ====== =========== ======== ======== =========================================
700
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
701
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
702
+ ``AnnualHeatingEfficiency[Units="AFUE"]/Value`` double frac 0-1 Yes Rated efficiency
703
+ ``ElectricAuxiliaryEnergy`` double kWh/yr >= 0 No [#]_ See [#]_ Electric auxiliary energy
704
+ ``extension/WaterLoopHeatPump/AnnualHeatingEfficiency[Units="COP"]/Value`` double W/W > 0 See [#]_ COP of the attached water loop heat pump
705
+ ========================================================================== ======== ====== =========== ======== ======== =========================================
706
+
707
+ .. [#] HVACDistribution type must be HydronicDistribution (type: "radiator", "baseboard", "radiant floor", or "radiant ceiling") or DSE for in-unit boilers, and HydronicDistribution (type: "radiator", "baseboard", "radiant floor", or "radiant ceiling") or HydronicAndAirDistribution (type: "fan coil" or "water loop heat pump") for shared boilers.
708
+ .. [#] | For shared boilers, ElectricAuxiliaryEnergy can alternatively be calculated as follows per `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_:
709
+ | EAE = (SP / N_dweq + aux_in) * HLH
710
+ | where
711
+ | SP = Shared pump power [W] provided as ``extension/SharedLoopWatts``,
712
+ | N_dweq = Number of units served by the shared system provided as ``NumberofUnitsServed``,
713
+ | aux_in = In-unit fan coil power [W] provided as ``extension/FanCoilWatts``,
714
+ | HLH = Annual heating load hours.
715
+ .. [#] If ElectricAuxiliaryEnergy not provided (nor calculated for shared boilers), defaults as follows per `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
716
+
717
+ - **Oil boiler**: 330
718
+ - **Gas boiler (in-unit)**: 170
719
+ - **Gas boiler (shared, w/ baseboard)**: 220
720
+ - **Gas boiler (shared, w/ water loop heat pump)**: 265
721
+ - **Gas boiler (shared, w/ fan coil)**: 438
722
+
723
+ .. [#] Water loop heat pump (WLHP) heating COP only required if a shared boiler connected to a water loop heat pump.
724
+
725
+ Stove
726
+ ~~~~~
727
+
728
+ If a stove is specified, additional information is entered in ``HeatingSystem``.
729
+
730
+ ================================================== ====== ===== =========== ======== ========= ===================
731
+ Element Type Units Constraints Required Default Notes
732
+ ================================================== ====== ===== =========== ======== ========= ===================
733
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0-1 Yes Efficiency
734
+ ``extension/FanPowerWatts`` double W >= 0 No 40 Installed fan power
735
+ ================================================== ====== ===== =========== ======== ========= ===================
736
+
737
+ Portable/Fixed Heater
738
+ ~~~~~~~~~~~~~~~~~~~~~
739
+
740
+ If a portable heater or fixed heater is specified, additional information is entered in ``HeatingSystem``.
741
+
742
+ ================================================== ====== ===== =========== ======== ========= ===================
743
+ Element Type Units Constraints Required Default Notes
744
+ ================================================== ====== ===== =========== ======== ========= ===================
745
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0-1 Yes Efficiency
746
+ ``extension/FanPowerWatts`` double W >= 0 No 0 Installed fan power
747
+ ================================================== ====== ===== =========== ======== ========= ===================
748
+
749
+ Fireplace
750
+ ~~~~~~~~~
751
+
752
+ If a fireplace is specified, additional information is entered in ``HeatingSystem``.
753
+
754
+ ================================================== ====== ===== =========== ======== ========= ===================
755
+ Element Type Units Constraints Required Default Notes
756
+ ================================================== ====== ===== =========== ======== ========= ===================
757
+ ``AnnualHeatingEfficiency[Units="Percent"]/Value`` double frac 0-1 Yes Efficiency
758
+ ``extension/FanPowerWatts`` double W >= 0 No 0 Installed fan power
759
+ ================================================== ====== ===== =========== ======== ========= ===================
760
+
761
+ .. _hvac_cooling:
762
+
763
+ HPXML Cooling Systems
764
+ *********************
765
+
766
+ Each cooling system (other than heat pumps) is entered as an ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/CoolingSystem``.
767
+
768
+ ========================== ======== ====== =========== ======== ======= ===============================
769
+ Element Type Units Constraints Required Default Notes
770
+ ========================== ======== ====== =========== ======== ======= ===============================
771
+ ``SystemIdentifier`` id Yes Unique identifier
772
+ ``CoolingSystemType`` string See [#]_ Yes Type of cooling system
773
+ ``CoolingSystemFuel`` string See [#]_ Yes Fuel type
774
+ ``FractionCoolLoadServed`` double frac 0-1 [#]_ Yes Fraction of cooling load served
775
+ ========================== ======== ====== =========== ======== ======= ===============================
776
+
777
+ .. [#] CoolingSystemType choices are "central air conditioner", "room air conditioner", "evaporative cooler", "mini-split", "chiller", or "cooling tower".
778
+ .. [#] CoolingSystemFuel only choice is "electricity".
779
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
780
+ For example, the dwelling unit could have two room air conditioners with values of 0.1 (10%) and 0.2 (20%), respectively, with the rest of the home (70%) uncooled.
781
+
782
+ Central Air Conditioner
783
+ ~~~~~~~~~~~~~~~~~~~~~~~
784
+
785
+ If a central air conditioner is specified, additional information is entered in ``CoolingSystem``.
786
+
787
+ =============================================== ======== ====== =========== ======== ========= ==================================
788
+ Element Type Units Constraints Required Default Notes
789
+ =============================================== ======== ====== =========== ======== ========= ==================================
790
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
791
+ ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated efficiency
792
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
793
+ ``SensibleHeatFraction`` double frac 0-1 No Sensible heat fraction
794
+ ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
795
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Installed fan efficiency
796
+ =============================================== ======== ====== =========== ======== ========= ==================================
797
+
798
+ .. [#] HVACDistribution type must be AirDistribution or DSE.
799
+ .. [#] CompressorType choices are "single stage", "two stage", or "variable speed".
800
+ .. [#] If CompressorType not provided, defaults to "single stage" if SEER <= 15, else "two stage" if SEER <= 21, else "variable speed".
801
+ .. [#] 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.
802
+
803
+ Room Air Conditioner
804
+ ~~~~~~~~~~~~~~~~~~~~
805
+
806
+ If a room air conditioner is specified, additional information is entered in ``CoolingSystem``.
807
+
808
+ ============================================== ======== ====== =========== ======== ========= ======================
809
+ Element Type Units Constraints Required Default Notes
810
+ ============================================== ======== ====== =========== ======== ========= ======================
811
+ ``AnnualCoolingEfficiency[Units="EER"]/Value`` double Btu/Wh > 0 Yes Rated efficiency
812
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
813
+ ``SensibleHeatFraction`` double frac 0-1 No Sensible heat fraction
814
+ ============================================== ======== ====== =========== ======== ========= ======================
815
+
816
+ Evaporative Cooler
817
+ ~~~~~~~~~~~~~~~~~~
818
+
819
+ If an evaporative cooler is specified, additional information is entered in ``CoolingSystem``.
820
+
821
+ ================================= ======== ====== =========== ======== ========= ==================================
822
+ Element Type Units Constraints Required Default Notes
823
+ ================================= ======== ====== =========== ======== ========= ==================================
824
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system
825
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Installed fan efficiency
826
+ ================================= ======== ====== =========== ======== ========= ==================================
827
+
828
+ .. [#] HVACDistribution type must be AirDistribution or DSE.
829
+ .. [#] If FanPowerWattsPerCFM not provided, defaults to MIN(2.79 * cfm^-0.29, 0.6) W/cfm.
830
+
831
+ Mini-Split
832
+ ~~~~~~~~~~
833
+
834
+ If a mini-split is specified, additional information is entered in ``CoolingSystem``.
835
+
836
+ ================================= ======== ====== =========== ======== ========= ==================================
837
+ Element Type Units Constraints Required Default Notes
838
+ ================================= ======== ====== =========== ======== ========= ==================================
839
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system
840
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
841
+ ``SensibleHeatFraction`` double frac 0-1 No Sensible heat fraction
842
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Installed fan efficiency
843
+ ================================= ======== ====== =========== ======== ========= ==================================
844
+
845
+ .. [#] HVACDistribution type must be AirDistribution or DSE.
846
+ .. [#] If FanPowerWattsPerCFM not provided, defaults to 0.07 W/cfm if ductless, else 0.18 W/cfm.
847
+
848
+ Chiller
849
+ ~~~~~~~
850
+
851
+ If a chiller is specified, additional information is entered in ``CoolingSystem``.
852
+
853
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
854
+ Element Type Units Constraints Required Default Notes
855
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
856
+ ``IsSharedSystem`` boolean true Yes Whether it serves multiple dwelling units
857
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
858
+ ``NumberofUnitsServed`` integer > 1 Yes Number of dwelling units served
859
+ ``CoolingCapacity`` double Btu/hr >= 0 Yes Total cooling capacity
860
+ ``AnnualCoolingEfficiency[Units="kW/ton"]/Value`` double kW/ton > 0 Yes Rated efficiency
861
+ ``extension/SharedLoopWatts`` double W >= 0 Yes Pumping and fan power serving the system
862
+ ``extension/FanCoilWatts`` double W >= 0 See [#]_ Fan coil power
863
+ ``extension/WaterLoopHeatPump/CoolingCapacity`` double Btu/hr > 0 See [#]_ Water loop heat pump cooling capacity
864
+ ``extension/WaterLoopHeatPump/AnnualCoolingEfficiency[Units="EER"]/Value`` double Btu/Wh > 0 See [#]_ Water loop heat pump efficiency
865
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
866
+
867
+ .. [#] HVACDistribution type must be HydronicDistribution (type: "radiator", "baseboard", "radiant floor", or "radiant ceiling") or HydronicAndAirDistribution (type: "fan coil" or "water loop heat pump").
868
+ .. [#] FanCoilWatts only required if chiller connected to a fan coil.
869
+ .. [#] WLHP CoolingCapacity only required if chiller connected to a water loop heat pump.
870
+ .. [#] WLHP Cooling EER only required if chiller connected to a water loop heat pump.
871
+
872
+ .. note::
873
+
874
+ 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>`_.
875
+
876
+ Cooling Tower w/ WLHP
877
+ ~~~~~~~~~~~~~~~~~~~~~
878
+
879
+ If a cooling tower w/ water loop heat pump (WLHP) is specified, additional information is entered in ``CoolingSystem``.
880
+
881
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
882
+ Element Type Units Constraints Required Default Notes
883
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
884
+ ``IsSharedSystem`` boolean true Yes Whether it serves multiple dwelling units
885
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
886
+ ``NumberofUnitsServed`` integer > 1 Yes Number of dwelling units served
887
+ ``extension/SharedLoopWatts`` double W >= 0 Yes Pumping and fan power serving the system
888
+ ``extension/WaterLoopHeatPump/CoolingCapacity`` double Btu/hr > 0 Yes Water loop heat pump cooling capacity
889
+ ``extension/WaterLoopHeatPump/AnnualCoolingEfficiency[Units="EER"]/Value`` double Btu/Wh > 0 Yes Water loop heat pump efficiency
890
+ ========================================================================== ======== ====== =========== ======== ========= =========================================
891
+
892
+ .. [#] HVACDistribution type must be HydronicAndAirDistribution (type: "water loop heat pump").
893
+
894
+ .. note::
895
+
896
+ Cooling towers w/ WLHPs 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>`_.
897
+
898
+ .. _hvac_heatpump:
899
+
900
+ HPXML Heat Pumps
901
+ ****************
902
+
903
+ Each heat pump is entered as an ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/HeatPump``.
904
+
905
+ ================================= ======== ====== =========== ======== ========= ===============================================
906
+ Element Type Units Constraints Required Default Notes
907
+ ================================= ======== ====== =========== ======== ========= ===============================================
908
+ ``SystemIdentifier`` id Yes Unique identifier
909
+ ``HeatPumpType`` string See [#]_ Yes Type of heat pump
910
+ ``HeatPumpFuel`` string See [#]_ Yes Fuel type
911
+ ``HeatingCapacity`` double Btu/hr >= 0 No autosized Heating capacity (excluding any backup heating)
912
+ ``CoolingCapacity`` double Btu/hr >= 0 No autosized Cooling capacity
913
+ ``CoolingSensibleHeatFraction`` double frac 0-1 No Sensible heat fraction
914
+ ``BackupSystemFuel`` string See [#]_ No Fuel type of backup heating, if present
915
+ ``FractionHeatLoadServed`` double frac 0-1 [#]_ Yes Fraction of heating load served
916
+ ``FractionCoolLoadServed`` double frac 0-1 [#]_ Yes Fraction of cooling load served
917
+ ================================= ======== ====== =========== ======== ========= ===============================================
918
+
919
+ .. [#] HeatPumpType choices are "air-to-air", "mini-split", or "ground-to-air".
920
+ .. [#] HeatPumpFuel only choice is "electricity".
921
+ .. [#] 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".
922
+ .. [#] The sum of all ``FractionHeatLoadServed`` (across both HeatingSystems and HeatPumps) must be less than or equal to 1.
923
+ For example, the dwelling unit could have a heat pump and a boiler heating system with values of 0.4 (40%) and 0.6 (60%), respectively.
924
+ .. [#] The sum of all ``FractionCoolLoadServed`` (across both CoolingSystems and HeatPumps) must be less than or equal to 1.
925
+ For example, the dwelling unit could have two mini-split heat pumps with values of 0.1 (10%) and 0.2 (20%), respectively, with the rest of the home (70%) uncooled.
926
+
927
+ If a backup system fuel is provided, additional information is entered in ``HeatPump``.
928
+
929
+ ======================================================================== ======== ====== =========== ======== ========= ==========================================
930
+ Element Type Units Constraints Required Default Notes
931
+ ======================================================================== ======== ====== =========== ======== ========= ==========================================
932
+ ``BackupAnnualHeatingEfficiency[Units="Percent" or Units="AFUE"]/Value`` double frac 0-1 Yes Backup heating efficiency
933
+ ``BackupHeatingCapacity`` double Btu/hr >= 0 No autosized Backup heating capacity
934
+ ``BackupHeatingSwitchoverTemperature`` double F No <none> Backup heating switchover temperature [#]_
935
+ ======================================================================== ======== ====== =========== ======== ========= ==========================================
936
+
937
+ .. [#] 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.
938
+ If not provided, the backup heating system will operate as needed when the heat pump has insufficient capacity.
939
+
940
+ .. note::
941
+
942
+ Water loop heat pumps in multifamily buildings should not be entered as a HeatPump.
943
+ Rather, enter them as a :ref:`hvac_heating` (shared boiler) and/or :ref:`hvac_cooling` (shared chiller or cooling tower).
944
+
945
+ Air-to-Air Heat Pump
946
+ ~~~~~~~~~~~~~~~~~~~~
947
+
948
+ If an air-to-air heat pump is specified, additional information is entered in ``HeatPump``.
949
+
950
+ =============================================== ======== ====== =========== ======== ========= =====================================
951
+ Element Type Units Constraints Required Default Notes
952
+ =============================================== ======== ====== =========== ======== ========= =====================================
953
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
954
+ ``CompressorType`` string See [#]_ No See [#]_ Type of compressor
955
+ ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
956
+ ``AnnualHeatingEfficiency[Units="HSPF"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency
957
+ ``HeatingCapacity17F`` double Btu/hr >= 0 No Heating capacity at 17F, if available
958
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Installed fan efficiency
959
+ =============================================== ======== ====== =========== ======== ========= =====================================
960
+
961
+ .. [#] HVACDistribution type must be AirDistribution or DSE.
962
+ .. [#] CompressorType choices are "single stage", "two stage", or "variable speed".
963
+ .. [#] If CompressorType not provided, defaults to "single stage" if SEER <= 15, else "two stage" if SEER <= 21, else "variable speed".
964
+ .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.5 W/cfm if HSPF <= 8.75, else 0.375 W/cfm.
965
+
966
+ Mini-Split Heat Pump
967
+ ~~~~~~~~~~~~~~~~~~~~
968
+
969
+ If a mini-split heat pump is specified, additional information is entered in ``HeatPump``.
970
+
971
+ =============================================== ======== ====== =========== ======== ========= ==============================================
972
+ Element Type Units Constraints Required Default Notes
973
+ =============================================== ======== ====== =========== ======== ========= ==============================================
974
+ ``DistributionSystem`` idref See [#]_ No ID of attached distribution system, if present
975
+ ``AnnualCoolingEfficiency[Units="SEER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
976
+ ``AnnualHeatingEfficiency[Units="HSPF"]/Value`` double Btu/Wh > 0 Yes Rated heating efficiency
977
+ ``HeatingCapacity17F`` double Btu/hr >= 0 No Heating capacity at 17F, if available
978
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Installed fan efficiency
979
+ =============================================== ======== ====== =========== ======== ========= ==============================================
980
+
981
+ .. [#] HVACDistribution type must be AirDistribution or DSE.
982
+ .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.07 W/cfm if ductless, else 0.18 W/cfm.
983
+
984
+ Ground-to-Air Heat Pump
985
+ ~~~~~~~~~~~~~~~~~~~~~~~
986
+
987
+ If a ground-to-air heat pump is specified, additional information is entered in ``HeatPump``.
988
+
989
+ =============================================== ======== ====== =========== ======== ========= ==============================================
990
+ Element Type Units Constraints Required Default Notes
991
+ =============================================== ======== ====== =========== ======== ========= ==============================================
992
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units [#]_
993
+ ``DistributionSystem`` idref See [#]_ Yes ID of attached distribution system
994
+ ``AnnualCoolingEfficiency[Units="EER"]/Value`` double Btu/Wh > 0 Yes Rated cooling efficiency
995
+ ``AnnualHeatingEfficiency[Units="COP"]/Value`` double W/W > 0 Yes Rated heating efficiency
996
+ ``extension/PumpPowerWattsPerTon`` double W/ton >= 0 No See [#]_ Installed pump efficiency
997
+ ``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Installed fan efficiency
998
+ ``NumberofUnitsServed`` integer > 1 See [#]_ Number of dwelling units served
999
+ ``extension/SharedLoopWatts`` double W >= 0 See [#]_ Shared pump power [#]_
1000
+ =============================================== ======== ====== =========== ======== ========= ==============================================
1001
+
1002
+ .. [#] IsSharedSystem should be true if the SFA/MF building has multiple ground source heat pumps connected to a shared hydronic circulation loop.
1003
+ .. [#] HVACDistribution type must be AirDistribution or DSE.
1004
+ .. [#] If PumpPowerWattsPerTon not provided, defaults to 30 W/ton of cooling capacity per `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_ for a closed loop system.
1005
+ .. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.5 W/cfm if COP <= 8.75/3.2, else 0.375 W/cfm.
1006
+ .. [#] NumberofUnitsServed only required if IsSharedSystem is true.
1007
+ .. [#] SharedLoopWatts only required if IsSharedSystem is true.
1008
+ .. [#] Shared loop pump power attributed to the dwelling unit is calculated as SharedLoopWatts / NumberofUnitsServed.
1009
+
1010
+ .. _hvac_control:
1011
+
1012
+ HPXML HVAC Control
1013
+ ******************
1014
+
1015
+ If any HVAC systems are specified, a single thermostat is entered as a ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACControl``.
1016
+
1017
+ ======================================================= ======== ======= =========== ======== ========= ========================================
1018
+ Element Type Units Constraints Required Default Notes
1019
+ ======================================================= ======== ======= =========== ======== ========= ========================================
1020
+ ``SystemIdentifier`` id Yes Unique identifier
1021
+ ``extension/CeilingFanSetpointTempCoolingSeasonOffset`` double F >= 0 No 0 Cooling setpoint temperature offset [#]_
1022
+ ======================================================= ======== ======= =========== ======== ========= ========================================
1023
+
1024
+ .. [#] CeilingFanSetpointTempCoolingSeasonOffset should only be used if there are sufficient ceiling fans present to warrant a reduced cooling setpoint.
1025
+
1026
+ Thermostat setpoints are additionally entered using either simple inputs or detailed inputs.
1027
+
1028
+ Simple Inputs
1029
+ ~~~~~~~~~~~~~
1030
+
1031
+ To define simple thermostat setpoints, additional information is entered in ``HVACControl``.
1032
+
1033
+ ============================= ======== ======= =========== ======== ========= ============================
1034
+ Element Type Units Constraints Required Default Notes
1035
+ ============================= ======== ======= =========== ======== ========= ============================
1036
+ ``SetpointTempHeatingSeason`` double F Yes Heating setpoint temperature
1037
+ ``SetpointTempCoolingSeason`` double F Yes Cooling setpoint temperature
1038
+ ============================= ======== ======= =========== ======== ========= ============================
1039
+
1040
+ If there is a heating temperature setback, additional information is entered in ``HVACControl``.
1041
+
1042
+ ===================================== ======== ======== =========== ======== ========= =========================================
1043
+ Element Type Units Constraints Required Default Notes
1044
+ ===================================== ======== ======== =========== ======== ========= =========================================
1045
+ ``SetbackTempHeatingSeason`` double F Yes Heating setback temperature
1046
+ ``TotalSetbackHoursperWeekHeating`` integer hrs/week > 0 Yes Hours/week of heating temperature setback
1047
+ ``extension/SetbackStartHourHeating`` integer 0-23 No 23 (11pm) Daily setback start hour
1048
+ ===================================== ======== ======== =========== ======== ========= =========================================
1049
+
1050
+ If there is a cooling temperature setup, additional information is entered in ``HVACControl``.
1051
+
1052
+ ===================================== ======== ======== =========== ======== ========= =========================================
1053
+ Element Type Units Constraints Required Default Notes
1054
+ ===================================== ======== ======== =========== ======== ========= =========================================
1055
+ ``SetupTempCoolingSeason`` double F Yes Cooling setup temperature
1056
+ ``TotalSetupHoursperWeekCooling`` integer hrs/week > 0 Yes Hours/week of cooling temperature setup
1057
+ ``extension/SetupStartHourCooling`` integer 0-23 No 9 (9am) Daily setup start hour
1058
+ ===================================== ======== ======== =========== ======== ========= =========================================
1059
+
1060
+ Detailed Inputs
1061
+ ~~~~~~~~~~~~~~~
1062
+
1063
+ To define detailed thermostat setpoints, additional information is entered in ``HVACControl``.
1064
+
1065
+ =============================================== ===== ======= =========== ======== ========= ============================================
1066
+ Element Type Units Constraints Required Default Notes
1067
+ =============================================== ===== ======= =========== ======== ========= ============================================
1068
+ ``extension/WeekdaySetpointTempsHeatingSeason`` array F Yes 24 comma-separated weekday heating setpoints
1069
+ ``extension/WeekendSetpointTempsHeatingSeason`` array F Yes 24 comma-separated weekend heating setpoints
1070
+ ``extension/WeekdaySetpointTempsCoolingSeason`` array F Yes 24 comma-separated weekday cooling setpoints
1071
+ ``extension/WeekendSetpointTempsCoolingSeason`` array F Yes 24 comma-separated weekend cooling setpoints
1072
+ =============================================== ===== ======= =========== ======== ========= ============================================
1073
+
1074
+ HPXML HVAC Distribution
1075
+ ***********************
1076
+
1077
+ Each separate HVAC distribution system is entered as a ``/HPXML/Building/BuildingDetails/Systems/HVAC/HVACDistribution``.
1078
+
1079
+ ============================== ======= ======= =========== ======== ========= =============================
1080
+ Element Type Units Constraints Required Default Notes
1081
+ ============================== ======= ======= =========== ======== ========= =============================
1082
+ ``SystemIdentifier`` id Yes Unique identifier
1083
+ ``DistributionSystemType`` element 1 [#]_ Yes Type of distribution system
1084
+ ``ConditionedFloorAreaServed`` double ft2 > 0 See [#]_ Conditioned floor area served
1085
+ ============================== ======= ======= =========== ======== ========= =============================
1086
+
1087
+ .. [#] DistributionSystemType child element choices are ``AirDistribution``, ``HydronicDistribution``, ``HydronicAndAirDistribution``, or ``Other=DSE``.
1088
+ .. [#] ConditionedFloorAreaServed is required for AirDistribution and HydronicAndAir types.
1089
+
1090
+ .. note::
1091
+
1092
+ There should be at most one heating system and one cooling system attached to a distribution system.
1093
+ See :ref:`hvac_heating`, :ref:`hvac_cooling`, and :ref:`hvac_heatpump` for information on which DistributionSystemType is allowed for which HVAC system.
1094
+ Also note that some HVAC systems (e.g., room air conditioners) are not allowed to be attached to a distribution system.
1095
+
1096
+ .. _air_distribution:
1097
+
1098
+ Air Distribution
1099
+ ~~~~~~~~~~~~~~~~
1100
+
1101
+ To define an air distribution system, additional information is entered in ``HVACDistribution/DistributionSystemType/AirDistribution``.
1102
+
1103
+ =========================== ======= ======= =========== ======== ========= ===========================================
1104
+ Element Type Units Constraints Required Default Notes
1105
+ =========================== ======= ======= =========== ======== ========= ===========================================
1106
+ ``DuctLeakageMeasurement`` element >= 0 No <none> Presence of supply/return duct leakage [#]_
1107
+ ``Ducts`` element >= 0 No <none> Presence of supply/return ducts [#]_
1108
+ ``NumberofReturnRegisters`` integer >= 0 No See [#]_ Number of return registers
1109
+ =========================== ======= ======= =========== ======== ========= ===========================================
1110
+
1111
+ .. [#] Provide one DuctLeakageMeasurement element for any supply ducts and one for any return ducts.
1112
+ .. [#] Provide one or more Ducts elements for any supply ducts and one or more for any return ducts.
1113
+ .. [#] If NumberofReturnRegisters not provided, 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.
1114
+
1115
+ If there is supply or return duct leakage, additional information is entered in a ``DuctLeakageMeasurement``.
1116
+
1117
+ ================================ ======= ======= =========== ======== ========= =========================================================
1118
+ Element Type Units Constraints Required Default Notes
1119
+ ================================ ======= ======= =========== ======== ========= =========================================================
1120
+ ``DuctType`` string See [#]_ Yes Supply or return ducts
1121
+ ``DuctLeakage/Units`` string See [#]_ Yes Duct leakage units
1122
+ ``DuctLeakage/Value`` double >= 0 Yes Duct leakage value
1123
+ ``DuctLeakage/TotalOrToOutside`` string See [#]_ Yes Type of duct leakage (outside conditioned space vs total)
1124
+ ================================ ======= ======= =========== ======== ========= =========================================================
1125
+
1126
+ .. [#] DuctType choices are "supply" or "return".
1127
+ .. [#] Units choices are "CFM25" or "Percent".
1128
+ .. [#] TotalOrToOutside only choice is "to outside".
1129
+
1130
+ If there are supply or return ducts, additional information is entered in a ``Ducts``.
1131
+
1132
+ ======================== ======= ============ =========== ======== ========= ===============================
1133
+ Element Type Units Constraints Required Default Notes
1134
+ ======================== ======= ============ =========== ======== ========= ===============================
1135
+ ``DuctInsulationRValue`` double F-ft2-hr/Btu >= 0 Yes R-value of duct insulation [#]_
1136
+ ``DuctSurfaceArea`` double ft2 >= 0 See [#]_ See [#]_ Duct surface area
1137
+ ``DuctLocation`` string See [#]_ See [#]_ See [#]_ Duct location
1138
+ ======================== ======= ============ =========== ======== ========= ===============================
1139
+
1140
+ .. [#] DuctInsulationRValue should not include air films (i.e., use 0 for an uninsulated duct).
1141
+ .. [#] DuctSurfaceArea and DuctLocation are either both required or both disallowed.
1142
+ .. [#] 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>`_:
1143
+
1144
+ - **Primary supply ducts**: 0.27 * F_out * ConditionedFloorAreaServed
1145
+ - **Secondary supply ducts**: 0.27 * (1 - F_out) * ConditionedFloorAreaServed
1146
+ - **Primary return ducts**: b_r * F_out * ConditionedFloorAreaServed
1147
+ - **Secondary return ducts**: b_r * (1 - F_out) * ConditionedFloorAreaServed
1148
+
1149
+ 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.
1150
+ .. [#] 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".
1151
+ See :ref:`hpxmllocations` for descriptions.
1152
+ .. [#] DuctLocation and DuctSurfaceArea are either both required or both disallowed.
1153
+ .. [#] 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".
1154
+ Any secondary ducts (i.e., when NumberofConditionedFloorsAboveGrade > 1) will always be located in "living space".
1155
+
1156
+ Hydronic Distribution
1157
+ ~~~~~~~~~~~~~~~~~~~~~
1158
+
1159
+ To define a hydronic distribution system, additional information is entered in ``HVACDistribution/DistributionSystemType/HydronicDistribution``.
1160
+
1161
+ ============================ ======= ======= =========== ======== ========= ====================================
1162
+ Element Type Units Constraints Required Default Notes
1163
+ ============================ ======= ======= =========== ======== ========= ====================================
1164
+ ``HydronicDistributionType`` string See [#]_ Yes Type of hydronic distribution system
1165
+ ============================ ======= ======= =========== ======== ========= ====================================
1166
+
1167
+ .. [#] HydronicDistributionType choices are "radiator", "baseboard", "radiant floor", or "radiant ceiling".
1168
+
1169
+ Hydronic And Air Distribution
1170
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1171
+
1172
+ To define an air and hydronic distribution system, additional information is entered in ``HVACDistribution/DistributionSystemType/HydronicAndAirDistribution``.
1173
+
1174
+ ================================== ======= ======= =========== ======== ========= ============================================
1175
+ Element Type Units Constraints Required Default Notes
1176
+ ================================== ======= ======= =========== ======== ========= ============================================
1177
+ ``HydronicAndAirDistributionType`` string See [#]_ Yes Type of hydronic and air distribution system
1178
+ ================================== ======= ======= =========== ======== ========= ============================================
1179
+
1180
+ .. [#] HydronicAndAirDistributionType choices are "fan coil" or "water loop heat pump".
1181
+
1182
+ In addition, if the system is ducted, all of the elements from the :ref:`air_distribution` Section can be entered in this ``HydronicAndAirDistribution`` element too (e.g., ``DuctLeakageMeasurement`` and ``Ducts``).
1183
+
1184
+ Distribution System Efficiency (DSE)
1185
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1186
+
1187
+ .. warning::
1188
+
1189
+ 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.
1190
+ 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.
1191
+
1192
+ To define a DSE system, additional information is entered in ``HVACDistribution``.
1193
+
1194
+ ============================================= ======= ======= =========== ======== ========= ===================================================
1195
+ Element Type Units Constraints Required Default Notes
1196
+ ============================================= ======= ======= =========== ======== ========= ===================================================
1197
+ ``AnnualHeatingDistributionSystemEfficiency`` double frac 0-1 Yes Seasonal distribution system efficiency for heating
1198
+ ``AnnualCoolingDistributionSystemEfficiency`` double frac 0-1 Yes Seasonal distribution system efficiency for cooling
1199
+ ============================================= ======= ======= =========== ======== ========= ===================================================
1200
+
1201
+ DSE values can be calculated from `ASHRAE Standard 152 <https://www.energy.gov/eere/buildings/downloads/ashrae-standard-152-spreadsheet>`_.
1202
+
1203
+ HPXML Whole Ventilation Fan
1204
+ ***************************
1205
+
1206
+ Each mechanical ventilation systems that provide ventilation to the whole dwelling unit is entered as a ``/HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan``.
1207
+
1208
+ ======================================= ======== ======= =========== ======== ========= =========================================
1209
+ Element Type Units Constraints Required Default Notes
1210
+ ======================================= ======== ======= =========== ======== ========= =========================================
1211
+ ``SystemIdentifier`` id Yes Unique identifier
1212
+ ``UsedForWholeBuildingVentilation`` boolean true Yes Must be set to true
1213
+ ``IsSharedSystem`` boolean See [#]_ No false Whether it serves multiple dwelling units
1214
+ ``FanType`` string See [#]_ Yes Type of ventilation system
1215
+ ``TestedFlowRate`` or ``RatedFlowRate`` double cfm >= 0 Yes Flow rate [#]_
1216
+ ``HoursInOperation`` double hrs/day 0-24 No See [#]_ Hours per day of operation
1217
+ ``FanPower`` double W >= 0 Yes Fan power
1218
+ ======================================= ======== ======= =========== ======== ========= =========================================
1219
+
1220
+ .. [#] For central fan integrated supply systems, IsSharedSystem must be false.
1221
+ .. [#] FanType choices are "energy recovery ventilator", "heat recovery ventilator", "exhaust only", "supply only", "balanced", or "central fan integrated supply".
1222
+ .. [#] For a central fan integrated supply system, the flow rate should equal the amount of outdoor air provided to the distribution system.
1223
+ .. [#] 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.
1224
+
1225
+ Exhaust/Supply Only
1226
+ ~~~~~~~~~~~~~~~~~~~
1227
+
1228
+ If a supply only or exhaust only system is specified, no additional information is entered.
1229
+
1230
+ Balanced
1231
+ ~~~~~~~~
1232
+
1233
+ If a balanced system is specified, no additional information is entered.
1234
+
1235
+ Heat Recovery Ventilator
1236
+ ~~~~~~~~~~~~~~~~~~~~~~~~
1237
+
1238
+ If a heat recovery ventilator system is specified, additional information is entered in ``VentilationFan``.
1239
+
1240
+ ======================================================================== ====== ===== =========== ======== ======= ============================
1241
+ Element Type Units Constraints Required Default Notes
1242
+ ======================================================================== ====== ===== =========== ======== ======= ============================
1243
+ ``SensibleRecoveryEfficiency`` or ``AdjustedSensibleRecoveryEfficiency`` double frac 0-1 Yes Sensible recovery efficiency
1244
+ ======================================================================== ====== ===== =========== ======== ======= ============================
1245
+
1246
+ Energy Recovery Ventilator
1247
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~
1248
+
1249
+ If an energy recovery ventilator system is specified, additional information is entered in ``VentilationFan``.
1250
+
1251
+ ======================================================================== ====== ===== =========== ======== ======= ============================
1252
+ Element Type Units Constraints Required Default Notes
1253
+ ======================================================================== ====== ===== =========== ======== ======= ============================
1254
+ ``TotalRecoveryEfficiency`` or ``AdjustedTotalRecoveryEfficiency`` double frac 0-1 Yes Total recovery efficiency
1255
+ ``SensibleRecoveryEfficiency`` or ``AdjustedSensibleRecoveryEfficiency`` double frac 0-1 Yes Sensible recovery efficiency
1256
+ ======================================================================== ====== ===== =========== ======== ======= ============================
1257
+
1258
+ Central Fan Integrated Supply
1259
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1260
+
1261
+ If a central fan integrated supply system is specified, additional information is entered in ``VentilationFan``.
1262
+
1263
+ ==================================== ====== ===== =========== ======== ======= ==================================
1264
+ Element Type Units Constraints Required Default Notes
1265
+ ==================================== ====== ===== =========== ======== ======= ==================================
1266
+ ``AttachedToHVACDistributionSystem`` idref See [#]_ Yes ID of attached distribution system
1267
+ ==================================== ====== ===== =========== ======== ======= ==================================
1268
+
1269
+ .. [#] HVACDistribution type cannot be HydronicDistribution.
1270
+
1271
+ Shared System
1272
+ ~~~~~~~~~~~~~
1273
+
1274
+ If the specified system is a shared system (i.e., serving multiple dwelling units), additional information is entered in ``VentilationFan``.
1275
+
1276
+ ============================ ======= ===== =========== ======== ======= ====================================================
1277
+ Element Type Units Constraints Required Default Notes
1278
+ ============================ ======= ===== =========== ======== ======= ====================================================
1279
+ ``FractionRecirculation`` double frac 0-1 Yes Fraction of supply air that is recirculated [#]_
1280
+ ``extension/InUnitFlowRate`` double cfm >= 0 Yes Flow rate delivered to the dwelling unit
1281
+ ``extension/PreHeating`` element 0-1 No <none> Supply air preconditioned by heating equipment? [#]_
1282
+ ``extension/PreCooling`` element 0-1 No <none> Supply air preconditioned by cooling equipment? [#]_
1283
+ ============================ ======= ===== =========== ======== ======= ====================================================
1284
+
1285
+ .. [#] 1-FractionRecirculation is assumed to be the fraction of supply air that is provided from outside.
1286
+ The value must be 0 for exhaust only systems.
1287
+ .. [#] PreHeating not allowed for exhaust only systems.
1288
+ .. [#] PreCooling not allowed for exhaust only systems.
1289
+
1290
+ If pre-heating is specified, additional information is entered in ``extension/PreHeating``.
1291
+
1292
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1293
+ Element Type Units Constraints Required Default Notes
1294
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1295
+ ``Fuel`` string See [#]_ Yes Pre-heating equipment fuel type
1296
+ ``AnnualHeatingEfficiency[Units="COP"]/Value`` double W/W > 0 Yes Pre-heating equipment annual COP
1297
+ ``FractionVentilationHeatLoadServed`` double frac 0-1 Yes Fraction of ventilation heating load served by pre-heating equipment
1298
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1299
+
1300
+ .. [#] 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".
1301
+
1302
+ If pre-cooling is specified, additional information is entered in ``extension/PreCooling``.
1303
+
1304
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1305
+ Element Type Units Constraints Required Default Notes
1306
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1307
+ ``Fuel`` string See [#]_ Yes Pre-cooling equipment fuel type
1308
+ ``AnnualCoolingEfficiency[Units="COP"]/Value`` double W/W > 0 Yes Pre-cooling equipment annual COP
1309
+ ``FractionVentilationCoolLoadServed`` double frac 0-1 Yes Fraction of ventilation cooling load served by pre-cooling equipment
1310
+ ============================================== ======= ===== =========== ======== ======= ====================================================================
1311
+
1312
+ .. [#] Fuel only choice is "electricity".
1313
+
1314
+ HPXML Local Ventilation Fan
1315
+ ***************************
1316
+
1317
+ Each kitchen range fan or bathroom fan that provides local ventilation is entered as a ``/HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan``.
1318
+
1319
+ =========================== ======= ======= =========== ======== ======== =============================
1320
+ Element Type Units Constraints Required Default Notes
1321
+ =========================== ======= ======= =========== ======== ======== =============================
1322
+ ``SystemIdentifier`` id Yes Unique identifier
1323
+ ``UsedForLocalVentilation`` boolean true Yes Must be set to true
1324
+ ``Quantity`` integer >= 0 No See [#]_ Number of identical fans
1325
+ ``RatedFlowRate`` double cfm >= 0 No See [#]_ Flow rate
1326
+ ``HoursInOperation`` double hrs/day 0-24 No See [#]_ Hours per day of operation
1327
+ ``FanLocation`` string See [#]_ Yes Location of the fan
1328
+ ``FanPower`` double W >= 0 No See [#]_ Fan power
1329
+ ``extension/StartHour`` integer 0-23 No See [#]_ Daily start hour of operation
1330
+ =========================== ======= ======= =========== ======== ======== =============================
1331
+
1332
+ .. [#] 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>`_.
1333
+ .. [#] 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>`_.
1334
+ .. [#] 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>`_.
1335
+ .. [#] FanLocation choices are "kitchen" or "bath".
1336
+ .. [#] 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>`_.
1337
+ .. [#] 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>`_.
1338
+
1339
+ HPXML Whole House Fan
1340
+ *********************
1341
+
1342
+ Each whole house fans that provides cooling load reduction is entered as a ``/HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan``.
1343
+
1344
+ ======================================= ======= ======= =========== ======== ======== ==========================
1345
+ Element Type Units Constraints Required Default Notes
1346
+ ======================================= ======= ======= =========== ======== ======== ==========================
1347
+ ``SystemIdentifier`` id Yes Unique identifier
1348
+ ``UsedForSeasonalCoolingLoadReduction`` boolean true Yes Must be set to true
1349
+ ``RatedFlowRate`` double cfm >= 0 Yes Flow rate
1350
+ ``FanPower`` double W >= 0 Yes Fan power
1351
+ ======================================= ======= ======= =========== ======== ======== ==========================
1352
+
1353
+ .. note::
1354
+
1355
+ The whole house fan is assumed to operate during hours of favorable outdoor conditions and will take priority over operable windows (natural ventilation).
1356
+
1357
+ HPXML Water Heating Systems
1358
+ ***************************
1359
+
1360
+ Each water heater is entered as a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/WaterHeatingSystem``.
1361
+
1362
+ ========================= ======= ======= =========== ======== ======== ================================================================
1363
+ Element Type Units Constraints Required Default Notes
1364
+ ========================= ======= ======= =========== ======== ======== ================================================================
1365
+ ``SystemIdentifier`` id Yes Unique identifier
1366
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units or shared laundry room
1367
+ ``WaterHeaterType`` string See [#]_ Yes Type of water heater
1368
+ ``Location`` string See [#]_ No See [#]_ Water heater location
1369
+ ``FractionDHWLoadServed`` double frac 0-1 [#]_ Yes Fraction of hot water load served [#]_
1370
+ ``HotWaterTemperature`` double F > 0 No 125 Water heater setpoint
1371
+ ``UsesDesuperheater`` boolean No false Presence of desuperheater?
1372
+ ``NumberofUnitsServed`` integer > 1 See [#]_ Number of dwelling units served directly or indirectly
1373
+ ========================= ======= ======= =========== ======== ======== ================================================================
1374
+
1375
+ .. [#] 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".
1376
+ .. [#] 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".
1377
+ See :ref:`hpxmllocations` for descriptions.
1378
+ .. [#] If Location not provided, defaults to the first present space type:
1379
+
1380
+ - **IECC zones 1-3, excluding 3A**: "garage", "living space"
1381
+ - **IECC zones 3A, 4-8, unknown**: "basement - conditioned", "basement - unconditioned", "living space"
1382
+
1383
+ .. [#] The sum of all ``FractionDHWLoadServed`` (across all WaterHeatingSystems) must equal to 1.
1384
+ .. [#] FractionDHWLoadServed represents only the fraction of the hot water load associated with the hot water **fixtures**.
1385
+ Additional hot water load from clothes washers/dishwashers will be automatically assigned to the appropriate water heater(s).
1386
+ .. [#] NumberofUnitsServed only required if IsSharedSystem is true.
1387
+
1388
+ Conventional Storage
1389
+ ~~~~~~~~~~~~~~~~~~~~
1390
+
1391
+ If a conventional storage water heater is specified, additional information is entered in ``WaterHeatingSystem``.
1392
+
1393
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1394
+ Element Type Units Constraints Required Default Notes
1395
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1396
+ ``FuelType`` string See [#]_ Yes Fuel type
1397
+ ``TankVolume`` double gal > 0 No See [#]_ Tank volume
1398
+ ``HeatingCapacity`` double Btuh > 0 No See [#]_ Heating capacity
1399
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac < 1 Yes EnergyGuide label rated efficiency
1400
+ ``FirstHourRating`` double gal/hr > 0 See [#]_ EnergyGuide label first hour rating
1401
+ ``RecoveryEfficiency`` double frac 0-1 No See [#]_ Recovery efficiency
1402
+ ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional tank insulation wrap
1403
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1404
+
1405
+ .. [#] 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".
1406
+ .. [#] 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>`_.
1407
+ .. [#] 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>`_.
1408
+ .. [#] FirstHourRating only required if UniformEnergyFactor provided.
1409
+ .. [#] 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>`_:
1410
+
1411
+ - **Electric**: 0.98
1412
+ - **Non-electric, EnergyFactor <= 0.75**: 0.778114 * EnergyFactor + 0.276679
1413
+ - **Non-electric, EnergyFactor > 0.75**: 0.252117 * EnergyFactor + 0.607997
1414
+
1415
+ Tankless
1416
+ ~~~~~~~~
1417
+
1418
+ If an instantaneous tankless water heater is specified, additional information is entered in ``WaterHeatingSystem``.
1419
+
1420
+ =========================================== ======= ============ =========== ============ ======== ==========================================================
1421
+ Element Type Units Constraints Required Default Notes
1422
+ =========================================== ======= ============ =========== ============ ======== ==========================================================
1423
+ ``FuelType`` string See [#]_ Yes Fuel type
1424
+ ``PerformanceAdjustment`` double frac No See [#]_ Multiplier on efficiency, typically to account for cycling
1425
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac < 1 Yes EnergyGuide label rated efficiency
1426
+ =========================================== ======= ============ =========== ============ ======== ==========================================================
1427
+
1428
+ .. [#] 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".
1429
+ .. [#] 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>`_.
1430
+
1431
+ Heat Pump
1432
+ ~~~~~~~~~
1433
+
1434
+ If a heat pump water heater is specified, additional information is entered in ``WaterHeatingSystem``.
1435
+
1436
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1437
+ Element Type Units Constraints Required Default Notes
1438
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1439
+ ``FuelType`` string See [#]_ Yes Fuel type
1440
+ ``TankVolume`` double gal > 0 Yes Tank volume
1441
+ ``UniformEnergyFactor`` or ``EnergyFactor`` double frac > 1 Yes EnergyGuide label rated efficiency
1442
+ ``FirstHourRating`` double gal/hr > 0 See [#]_ EnergyGuide label first hour rating
1443
+ ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional tank insulation wrap
1444
+ ============================================= ======= ============ =========== ======== ======== ==========================================
1445
+
1446
+ .. [#] FuelType only choice is "electricity".
1447
+ .. [#] FirstHourRating only required if UniformEnergyFactor provided.
1448
+
1449
+ Combi Boiler w/ Storage
1450
+ ~~~~~~~~~~~~~~~~~~~~~~~
1451
+
1452
+ If a combination boiler w/ storage tank (sometimes referred to as an indirect water heater) is specified, additional information is entered in ``WaterHeatingSystem``.
1453
+
1454
+ ============================================= ======= ============ =========== ============ ======== ==================================================
1455
+ Element Type Units Constraints Required Default Notes
1456
+ ============================================= ======= ============ =========== ============ ======== ==================================================
1457
+ ``RelatedHVACSystem`` idref See [#]_ Yes ID of boiler
1458
+ ``TankVolume`` double gal > 0 Yes Volume of the storage tank
1459
+ ``WaterHeaterInsulation/Jacket/JacketRValue`` double F-ft2-hr/Btu >= 0 No 0 R-value of additional storage tank insulation wrap
1460
+ ``StandbyLoss`` double F/hr > 0 No See [#]_ Storage tank standby losses
1461
+ ============================================= ======= ============ =========== ============ ======== ==================================================
1462
+
1463
+ .. [#] RelatedHVACSystem must reference a ``HeatingSystem`` of type Boiler.
1464
+ .. [#] If StandbyLoss not provided, defaults based on a regression analysis of `AHRI Directory of Certified Product Performance <https://www.ahridirectory.org>`_.
1465
+
1466
+ Combi Boiler w/ Tankless Coil
1467
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1468
+
1469
+ If a combination boiler w/ tankless coil is specified, additional information is entered in ``WaterHeatingSystem``.
1470
+
1471
+ ===================== ======= ============ =========== ============ ======== ==================================================
1472
+ Element Type Units Constraints Required Default Notes
1473
+ ===================== ======= ============ =========== ============ ======== ==================================================
1474
+ ``RelatedHVACSystem`` idref See [#]_ Yes ID of boiler
1475
+ ===================== ======= ============ =========== ============ ======== ==================================================
1476
+
1477
+ .. [#] RelatedHVACSystem must reference a ``HeatingSystem`` (Boiler).
1478
+
1479
+ Desuperheater
1480
+ ~~~~~~~~~~~~~
1481
+
1482
+ If the water heater uses a desuperheater, additional information is entered in ``WaterHeatingSystem``.
1483
+
1484
+ ===================== ======= ============ =========== ============ ======== ==================================
1485
+ Element Type Units Constraints Required Default Notes
1486
+ ===================== ======= ============ =========== ============ ======== ==================================
1487
+ ``RelatedHVACSystem`` idref See [#]_ Yes ID of heat pump or air conditioner
1488
+ ===================== ======= ============ =========== ============ ======== ==================================
1489
+
1490
+ .. [#] RelatedHVACSystem must reference a ``HeatPump`` (air-to-air, mini-split, or ground-to-air) or ``CoolingSystem`` (central air conditioner or mini-split).
1491
+
1492
+ HPXML Hot Water Distribution
1493
+ ****************************
1494
+
1495
+ If any water heating systems are provided, a single hot water distribution system is entered as a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/HotWaterDistribution``.
1496
+
1497
+ ================================= ======= ============ =========== ======== ======== =======================================================================
1498
+ Element Type Units Constraints Required Default Notes
1499
+ ================================= ======= ============ =========== ======== ======== =======================================================================
1500
+ ``SystemIdentifier`` id Yes Unique identifier
1501
+ ``SystemType`` element 1 [#]_ Yes Type of in-unit distribution system serving the dwelling unit
1502
+ ``PipeInsulation/PipeRValue`` double F-ft2-hr/Btu >= 0 No 0.0 Pipe insulation R-value
1503
+ ``DrainWaterHeatRecovery`` element 0-1 No <none> Presence of drain water heat recovery device
1504
+ ``extension/SharedRecirculation`` element 0-1 [#]_ No <none> Presence of shared recirculation system serving multiple dwelling units
1505
+ ================================= ======= ============ =========== ======== ======== =======================================================================
1506
+
1507
+ .. [#] SystemType child element choices are ``Standard`` and ``Recirculation``.
1508
+ .. [#] If SharedRecirculation is provided, SystemType must be ``Standard``.
1509
+ 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.
1510
+
1511
+ .. note::
1512
+
1513
+ In attached/multifamily buildings, only the hot water distribution system serving the dwelling unit should be defined.
1514
+ The hot water distribution associated with, e.g., a shared laundry room should not be defined.
1515
+
1516
+ Standard
1517
+ ~~~~~~~~
1518
+
1519
+ If the in-unit distribution system is specified as standard, additional information is entered in ``SystemType/Standard``.
1520
+
1521
+ ================ ======= ===== =========== ======== ======== =====================
1522
+ Element Type Units Constraints Required Default Notes
1523
+ ================ ======= ===== =========== ======== ======== =====================
1524
+ ``PipingLength`` double ft > 0 No See [#]_ Length of piping [#]_
1525
+ ================ ======= ===== =========== ======== ======== =====================
1526
+
1527
+ .. [#] | If PipingLength not provided, calculated using the following equation from `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_:
1528
+ | PipeL = 2.0 * (CFA / NCfl)^0.5 + 10.0 * NCfl + 5.0 * Bsmnt
1529
+ | where
1530
+ | CFA = conditioned floor area [ft2],
1531
+ | NCfl = number of conditioned floor levels number of conditioned floor levels in the residence including conditioned basements,
1532
+ | Bsmnt = presence (1.0) or absence (0.0) of an unconditioned basement in the residence.
1533
+ .. [#] 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).
1534
+
1535
+ Recirculation
1536
+ ~~~~~~~~~~~~~
1537
+
1538
+ If the in-unit distribution system is specified as recirculation, additional information is entered in ``SystemType/Recirculation``.
1539
+
1540
+ ================================= ======= ===== =========== ======== ======== =====================================
1541
+ Element Type Units Constraints Required Default Notes
1542
+ ================================= ======= ===== =========== ======== ======== =====================================
1543
+ ``ControlType`` string See [#]_ Yes Recirculation control type
1544
+ ``RecirculationPipingLoopLength`` double ft > 0 No See [#]_ Recirculation piping loop length [#]_
1545
+ ``BranchPipingLoopLength`` double ft > 0 No 10 Branch piping loop length [#]_
1546
+ ``PumpPower`` double W >= 0 No 50 [#]_ Recirculation pump power
1547
+ ================================= ======= ===== =========== ======== ======== =====================================
1548
+
1549
+ .. [#] ControlType choices are "manual demand control", "presence sensor demand control", "temperature", "timer", or "no control".
1550
+ .. [#] | If RecirculationPipingLoopLength not provided, calculated using the following equation from `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_:
1551
+ | RecircPipeL = 2.0 * (2.0 * (CFA / NCfl)^0.5 + 10.0 * NCfl + 5.0 * Bsmnt) - 20.0
1552
+ | where
1553
+ | CFA = conditioned floor area [ft2],
1554
+ | NCfl = number of conditioned floor levels number of conditioned floor levels in the residence including conditioned basements,
1555
+ | Bsmnt = presence (1.0) or absence (0.0) of an unconditioned basement in the residence.
1556
+ .. [#] 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.
1557
+ .. [#] 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.
1558
+ .. [#] PumpPower default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
1559
+
1560
+ Shared Recirculation
1561
+ ~~~~~~~~~~~~~~~~~~~~
1562
+
1563
+ If a shared recirculation system is specified, additional information is entered in ``extension/SharedRecirculation``.
1564
+
1565
+ ======================= ======= ===== =========== ======== ======== =================================
1566
+ Element Type Units Constraints Required Default Notes
1567
+ ======================= ======= ===== =========== ======== ======== =================================
1568
+ ``NumberofUnitsServed`` integer > 1 Yes Number of dwelling units served
1569
+ ``PumpPower`` double W >= 0 No 220 [#]_ Shared recirculation pump power
1570
+ ``ControlType`` string See [#]_ Yes Shared recirculation control type
1571
+ ======================= ======= ===== =========== ======== ======== =================================
1572
+
1573
+ .. [#] PumpPower default based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
1574
+ .. [#] ControlType choices are "manual demand control", "presence sensor demand control", "timer", or "no control".
1575
+
1576
+ Drain Water Heat Recovery
1577
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
1578
+
1579
+ If a drain water heat recovery (DWHR) device is specified, additional information is entered in ``DrainWaterHeatRecovery``.
1580
+
1581
+ ======================= ======= ===== =========== ======== ======== =========================================
1582
+ Element Type Units Constraints Required Default Notes
1583
+ ======================= ======= ===== =========== ======== ======== =========================================
1584
+ ``FacilitiesConnected`` string See [#]_ Yes Specifies which facilities are connected
1585
+ ``EqualFlow`` boolean Yes Specifies how the DHWR is configured [#]_
1586
+ ``Efficiency`` double frac 0-1 Yes Efficiency according to CSA 55.1
1587
+ ======================= ======= ===== =========== ======== ======== =========================================
1588
+
1589
+ .. [#] FacilitiesConnected choices are "one" or "all".
1590
+ Use "one" if there are multiple showers and only one of them is connected to the DWHR.
1591
+ 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.
1592
+ .. [#] 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.
1593
+
1594
+ HPXML Water Fixtures
1595
+ ********************
1596
+
1597
+ Each water fixture is entered as a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/WaterFixture``.
1598
+
1599
+ ==================== ======= ===== =========== ======== ======== ===============================================
1600
+ Element Type Units Constraints Required Default Notes
1601
+ ==================== ======= ===== =========== ======== ======== ===============================================
1602
+ ``SystemIdentifier`` id Yes Unique identifier
1603
+ ``WaterFixtureType`` string See [#]_ Yes Type of water fixture
1604
+ ``LowFlow`` boolean Yes Whether the fixture is considered low-flow [#]_
1605
+ ==================== ======= ===== =========== ======== ======== ===============================================
1606
+
1607
+ .. [#] WaterFixtureType choices are "shower head" or "faucet".
1608
+ .. [#] LowFlow should be true if the fixture's flow rate (gpm) is <= 2.0.
1609
+
1610
+ In addition, a ``/HPXML/Building/BuildingDetails/Systems/WaterHeating/extension/WaterFixturesUsageMultiplier`` can be optionally provided that scales hot water usage.
1611
+ if not provided, it is assumed to be 1.0.
1612
+
1613
+ HPXML Solar Thermal
1614
+ *******************
1615
+
1616
+ A single solar hot water system can be entered as a ``/HPXML/Building/BuildingDetails/Systems/SolarThermal/SolarThermalSystem``.
1617
+
1618
+ ==================== ======= ===== =========== ======== ======== ============================
1619
+ Element Type Units Constraints Required Default Notes
1620
+ ==================== ======= ===== =========== ======== ======== ============================
1621
+ ``SystemIdentifier`` id Yes Unique identifier
1622
+ ``SystemType`` string See [#]_ Yes Type of solar thermal system
1623
+ ==================== ======= ===== =========== ======== ======== ============================
1624
+
1625
+ .. [#] SystemType only choice is "hot water".
1626
+
1627
+ Solar hot water systems can be described with either simple or detailed inputs.
1628
+
1629
+ Simple Inputs
1630
+ ~~~~~~~~~~~~~
1631
+
1632
+ To define a simple solar hot water system, additional information is entered in ``SolarThermalSystem``.
1633
+
1634
+ ================= ======= ===== =========== ======== ======== ======================
1635
+ Element Type Units Constraints Required Default Notes
1636
+ ================= ======= ===== =========== ======== ======== ======================
1637
+ ``SolarFraction`` double frac 0-1 Yes Solar fraction [#]_
1638
+ ``ConnectedTo`` idref See [#]_ No [#]_ <none> Connected water heater
1639
+ ================= ======= ===== =========== ======== ======== ======================
1640
+
1641
+ .. [#] Portion of total conventional hot water heating load (delivered energy plus tank standby losses).
1642
+ 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.
1643
+ .. [#] ConnectedTo must reference a ``WaterHeatingSystem``.
1644
+ The referenced water heater cannot be a space-heating boiler nor attached to a desuperheater.
1645
+ .. [#] If ConnectedTo not provided, solar fraction will apply to all water heaters in the building.
1646
+
1647
+ Detailed Inputs
1648
+ ~~~~~~~~~~~~~~~
1649
+
1650
+ To define a detailed solar hot water system, additional information is entered in ``SolarThermalSystem``.
1651
+
1652
+ =================================== ======= ============ =========== ======== ======== ==============================
1653
+ Element Type Units Constraints Required Default Notes
1654
+ =================================== ======= ============ =========== ======== ======== ==============================
1655
+ ``CollectorArea`` double ft2 > 0 Yes Area
1656
+ ``CollectorLoopType`` string See [#]_ Yes Loop type
1657
+ ``CollectorType`` string See [#]_ Yes System type
1658
+ ``CollectorAzimuth`` integer deg 0-359 Yes Azimuth (clockwise from North)
1659
+ ``CollectorTilt`` double deg 0-90 Yes Tilt relative to horizontal
1660
+ ``CollectorRatedOpticalEfficiency`` double frac 0-1 Yes Rated optical efficiency [#]_
1661
+ ``CollectorRatedThermalLosses`` double Btu/hr-ft2-R > 0 Yes Rated thermal losses [#]_
1662
+ ``StorageVolume`` double gal > 0 No See [#]_ Hot water storage volume
1663
+ ``ConnectedTo`` idref See [#]_ Yes Connected water heater
1664
+ =================================== ======= ============ =========== ======== ======== ==============================
1665
+
1666
+ .. [#] CollectorLoopType choices are "liquid indirect", "liquid direct", or "passive thermosyphon".
1667
+ .. [#] CollectorType choices are "single glazing black", "double glazing black", "evacuated tube", or "integrated collector storage".
1668
+ .. [#] CollectorRatedOpticalEfficiency is FRTA (y-intercept) from the `Directory of SRCC OG-100 Certified Solar Collector Ratings <https://solar-rating.org/programs/og-100-program/>`_.
1669
+ .. [#] CollectorRatedThermalLosses is FRUL (slope) from the `Directory of SRCC OG-100 Certified Solar Collector Ratings <https://solar-rating.org/programs/og-100-program/>`_.
1670
+ .. [#] If StorageVolume not provided, calculated as 1.5 gal/ft2 * CollectorArea.
1671
+ .. [#] ConnectedTo must reference a ``WaterHeatingSystem`` that is not of type space-heating boiler nor connected to a desuperheater.
1672
+
1673
+ HPXML Photovoltaics
1674
+ *******************
1675
+
1676
+ Each solar electric photovoltaic (PV) system is entered as a ``/HPXML/Building/BuildingDetails/Systems/Photovoltaics/PVSystem``.
1677
+
1678
+ Many of the inputs are adopted from the `PVWatts model <https://pvwatts.nrel.gov>`_.
1679
+
1680
+ ======================================================= ================= ========= ============= ======== ======== ============================================
1681
+ Element Type Units Constraints Required Default Notes
1682
+ ======================================================= ================= ========= ============= ======== ======== ============================================
1683
+ ``SystemIdentifier`` id Yes Unique identifier
1684
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
1685
+ ``Location`` string See [#]_ No roof Mounting location
1686
+ ``ModuleType`` string See [#]_ No standard Type of module
1687
+ ``Tracking`` string See [#]_ No fixed Type of tracking
1688
+ ``ArrayAzimuth`` integer deg 0-359 Yes Direction panels face (clockwise from North)
1689
+ ``ArrayTilt`` double deg 0-90 Yes Tilt relative to horizontal
1690
+ ``MaxPowerOutput`` double W >= 0 Yes Peak power
1691
+ ``InverterEfficiency`` double frac 0-1 No 0.96 Inverter efficiency
1692
+ ``SystemLossesFraction`` or ``YearModulesManufactured`` double or integer frac or # 0-1 or > 1600 No 0.14 System losses [#]_
1693
+ ``extension/NumberofBedroomsServed`` integer > 1 See [#]_ Number of bedrooms served
1694
+ ======================================================= ================= ========= ============= ======== ======== ============================================
1695
+
1696
+ .. [#] Location choices are "ground" or "roof" mounted.
1697
+ .. [#] ModuleType choices are "standard", "premium", or "thin film".
1698
+ .. [#] Tracking choices are "fixed", "1-axis", "1-axis backtracked", or "2-axis".
1699
+ .. [#] System losses due to soiling, shading, snow, mismatch, wiring, degradation, etc.
1700
+ If YearModulesManufactured provided but not SystemLossesFraction, system losses calculated as:
1701
+ SystemLossesFraction = 1.0 - (1.0 - 0.14) * (1.0 - (1.0 - 0.995^(CurrentYear - YearModulesManufactured))).
1702
+ .. [#] NumberofBedroomsServed only required if IsSharedSystem is true.
1703
+ 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.
1704
+
1705
+ HPXML Generators
1706
+ ****************
1707
+
1708
+ Each generator that provides on-site power is entered as a ``/HPXML/Building/BuildingDetails/Systems/extension/Generators/Generator``.
1709
+
1710
+ ========================== ======= ======= =========== ======== ======= ============================================
1711
+ Element Type Units Constraints Required Default Notes
1712
+ ========================== ======= ======= =========== ======== ======= ============================================
1713
+ ``SystemIdentifier`` id Yes Unique identifier
1714
+ ``IsSharedSystem`` boolean No false Whether it serves multiple dwelling units
1715
+ ``FuelType`` string See [#]_ Yes Fuel type
1716
+ ``AnnualConsumptionkBtu`` double kBtu/yr > 0 Yes Annual fuel consumed
1717
+ ``AnnualOutputkWh`` double kWh/yr > 0 Yes Annual electricity produced
1718
+ ``NumberofBedroomsServed`` integer > 1 See [#]_ Number of bedrooms served
1719
+ ========================== ======= ======= =========== ======== ======= ============================================
1720
+
1721
+ .. [#] FuelType choices are "natural gas" or "propane".
1722
+ .. [#] NumberofBedroomsServed only required if IsSharedSystem is true.
1723
+ 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.
1724
+
1725
+ .. note::
1726
+
1727
+ Generators will be modeled as operating continuously (24/7).
1728
+
1729
+ HPXML Appliances
1730
+ ----------------
1731
+
1732
+ Appliances entered in ``/HPXML/Building/BuildingDetails/Appliances``.
1733
+
1734
+ HPXML Clothes Washer
1735
+ ********************
1736
+
1737
+ A single clothes washer can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/ClothesWasher``.
1738
+
1739
+ ============================================================== ======= =========== =========== ======== ============ ==============================================
1740
+ Element Type Units Constraints Required Default Notes
1741
+ ============================================================== ======= =========== =========== ======== ============ ==============================================
1742
+ ``SystemIdentifier`` id Yes Unique identifier
1743
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
1744
+ ``Location`` string See [#]_ No living space Location
1745
+ ``IntegratedModifiedEnergyFactor`` or ``ModifiedEnergyFactor`` double ft3/kWh/cyc > 0 No See [#]_ EnergyGuide label efficiency [#]_
1746
+ ``AttachedToWaterHeatingSystem`` idref See [#]_ See [#]_ ID of attached water heater
1747
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
1748
+ ============================================================== ======= =========== =========== ======== ============ ==============================================
1749
+
1750
+ .. [#] For example, a clothes washer in a shared laundry room of a MF building.
1751
+ .. [#] 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".
1752
+ See :ref:`hpxmllocations` for descriptions.
1753
+ .. [#] If neither IntegratedModifiedEnergyFactor nor ModifiedEnergyFactor provided, the following default values representing a standard clothes washer from 2006 will be used:
1754
+ IntegratedModifiedEnergyFactor = 1.0,
1755
+ RatedAnnualkWh = 400,
1756
+ LabelElectricRate = 0.12,
1757
+ LabelGasRate = 1.09,
1758
+ LabelAnnualGasCost = 27.0,
1759
+ LabelUsage = 6,
1760
+ Capacity = 3.0.
1761
+ .. [#] 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>`_:
1762
+ IMEF = (MEF - 0.503) / 0.95.
1763
+ .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``.
1764
+ .. [#] AttachedToWaterHeatingSystem only required if IsSharedAppliance is true.
1765
+
1766
+ If IntegratedModifiedEnergyFactor or ModifiedEnergyFactor is provided, a complete set of EnergyGuide label information is entered in ``ClothesWasher``.
1767
+
1768
+ ================================ ======= ======= =========== ============ ======= ====================================
1769
+ Element Type Units Constraints Required Default Notes
1770
+ ================================ ======= ======= =========== ============ ======= ====================================
1771
+ ``RatedAnnualkWh`` double kWh/yr > 0 Yes EnergyGuide label annual consumption
1772
+ ``LabelElectricRate`` double $/kWh > 0 Yes EnergyGuide label electricity rate
1773
+ ``LabelGasRate`` double $/therm > 0 Yes EnergyGuide label natural gas rate
1774
+ ``LabelAnnualGasCost`` double $ > 0 Yes EnergyGuide label annual gas cost
1775
+ ``LabelUsage`` double cyc/wk > 0 Yes EnergyGuide label number of cycles
1776
+ ``Capacity`` double ft3 > 0 Yes Clothes dryer volume
1777
+ ================================ ======= ======= =========== ============ ======= ====================================
1778
+
1779
+ HPXML Clothes Dryer
1780
+ *******************
1781
+
1782
+ A single clothes dryer can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/ClothesDryer``.
1783
+
1784
+ ============================================ ======= ====== =========== ======== ============ ==============================================
1785
+ Element Type Units Constraints Required Default Notes
1786
+ ============================================ ======= ====== =========== ======== ============ ==============================================
1787
+ ``SystemIdentifier`` id Yes Unique identifier
1788
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
1789
+ ``Location`` string See [#]_ No living space Location
1790
+ ``FuelType`` string See [#]_ Yes Fuel type
1791
+ ``CombinedEnergyFactor`` or ``EnergyFactor`` double lb/kWh > 0 No See [#]_ EnergyGuide label efficiency [#]_
1792
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
1793
+ ``extension/IsVented`` boolean No true Whether dryer is vented
1794
+ ``extension/VentedFlowRate`` double cfm >= 0 See [#]_ 100 [#]_ Exhust flow rate during operation
1795
+ ============================================ ======= ====== =========== ======== ============ ==============================================
1796
+
1797
+ .. [#] For example, a clothes dryer in a shared laundry room of a MF building.
1798
+ .. [#] 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".
1799
+ See :ref:`hpxmllocations` for descriptions.
1800
+ .. [#] 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".
1801
+ .. [#] If neither CombinedEnergyFactor nor EnergyFactor provided, the following default values representing a standard clothes dryer from 2006 will be used:
1802
+ CombinedEnergyFactor = 3.01,
1803
+ ControlType = timer.
1804
+ .. [#] 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>`_:
1805
+ CEF = EF / 1.15.
1806
+ .. [#] VentedFlowRate only required if IsVented is true.
1807
+ .. [#] VentedFlowRate default based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1808
+
1809
+ If the CombinedEnergyFactor or EnergyFactor is provided, a complete set of EnergyGuide label information is entered in ``ClothesDryer``.
1810
+
1811
+ =============== ======= ======= =========== ======== ======= ================
1812
+ Element Type Units Constraints Required Default Notes
1813
+ =============== ======= ======= =========== ======== ======= ================
1814
+ ``ControlType`` string See [#]_ Yes Type of controls
1815
+ =============== ======= ======= =========== ======== ======= ================
1816
+
1817
+ .. [#] ControlType choices are "timer" or "moisture".
1818
+
1819
+ HPXML Dishwasher
1820
+ ****************
1821
+
1822
+ A single dishwasher can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Dishwasher``.
1823
+
1824
+ ============================================ ======= =========== =========== ======== ============ ==============================================
1825
+ Element Type Units Constraints Required Default Notes
1826
+ ============================================ ======= =========== =========== ======== ============ ==============================================
1827
+ ``SystemIdentifier`` id Yes Unique identifier
1828
+ ``IsSharedAppliance`` boolean No false Whether it serves multiple dwelling units [#]_
1829
+ ``Location`` string See [#]_ No living space Location
1830
+ ``RatedAnnualkWh`` or ``EnergyFactor`` double kWh/yr or # > 0 No See [#]_ EnergyGuide label consumption/efficiency [#]_
1831
+ ``AttachedToWaterHeatingSystem`` idref See [#]_ See [#]_ ID of attached water heater
1832
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy & hot water usage
1833
+ ============================================ ======= =========== =========== ======== ============ ==============================================
1834
+
1835
+ .. [#] For example, a dishwasher in a shared mechanical room of a MF building.
1836
+ .. [#] 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".
1837
+ See :ref:`hpxmllocations` for descriptions.
1838
+ .. [#] If neither RatedAnnualkWh nor EnergyFactor provided, the following default values representing a standard dishwasher from 2006 will be used:
1839
+ RatedAnnualkWh = 467,
1840
+ LabelElectricRate = 0.12,
1841
+ LabelGasRate = 1.09,
1842
+ LabelAnnualGasCost = 33.12,
1843
+ LabelUsage = 4,
1844
+ PlaceSettingCapacity = 12.
1845
+ .. [#] 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>`_:
1846
+ RatedAnnualkWh = 215.0 / EF.
1847
+ .. [#] AttachedToWaterHeatingSystem must reference a ``WaterHeatingSystem``.
1848
+ .. [#] AttachedToWaterHeatingSystem only required if IsSharedAppliance is true.
1849
+
1850
+ If the RatedAnnualkWh or EnergyFactor is provided, a complete set of EnergyGuide label information is entered in ``Dishwasher``.
1851
+
1852
+ ======================== ======= ======= =========== ======== ======= ==================================
1853
+ Element Type Units Constraints Required Default Notes
1854
+ ======================== ======= ======= =========== ======== ======= ==================================
1855
+ ``LabelElectricRate`` double $/kWh > 0 Yes EnergyGuide label electricity rate
1856
+ ``LabelGasRate`` double $/therm > 0 Yes EnergyGuide label natural gas rate
1857
+ ``LabelAnnualGasCost`` double $ > 0 Yes EnergyGuide label annual gas cost
1858
+ ``LabelUsage`` double cyc/wk > 0 Yes EnergyGuide label number of cycles
1859
+ ``PlaceSettingCapacity`` integer # > 0 Yes Number of place settings
1860
+ ======================== ======= ======= =========== ======== ======= ==================================
1861
+
1862
+ HPXML Refrigerators
1863
+ *******************
1864
+
1865
+ Each refrigerator can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Refrigerator``.
1866
+
1867
+ ===================================================== ======= ====== =========== ======== ======== ======================================
1868
+ Element Type Units Constraints Required Default Notes
1869
+ ===================================================== ======= ====== =========== ======== ======== ======================================
1870
+ ``SystemIdentifier`` id Yes Unique identifier
1871
+ ``Location`` string See [#]_ No See [#]_ Location
1872
+ ``RatedAnnualkWh`` or ``extension/AdjustedAnnualkWh`` double kWh/yr > 0 No See [#]_ Annual consumption
1873
+ ``PrimaryIndicator`` boolean See [#]_ Primary refrigerator?
1874
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
1875
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
1876
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
1877
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
1878
+ ===================================================== ======= ====== =========== ======== ======== ======================================
1879
+
1880
+ .. [#] 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".
1881
+ See :ref:`hpxmllocations` for descriptions.
1882
+ .. [#] If Location not provided and is the *primary* refrigerator, defaults to "living space".
1883
+ If Location not provided and is a *secondary* refrigerator, defaults to the first present space type: "garage", "basement - unconditioned", "basement - conditioned", or "living space".
1884
+ .. [#] 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>`_:
1885
+ RatedAnnualkWh = 637.0 + 18.0 * NumberofBedrooms.
1886
+ .. [#] If multiple refrigerators are specified, there must be exactly one refrigerator described with PrimaryIndicator=true.
1887
+ .. [#] 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".
1888
+ .. [#] 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".
1889
+
1890
+ HPXML Freezers
1891
+ **************
1892
+
1893
+ Each standalone freezer can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Freezer``.
1894
+
1895
+ ===================================================== ====== ====== =========== ======== ========== ======================================
1896
+ Element Type Units Constraints Required Default Notes
1897
+ ===================================================== ====== ====== =========== ======== ========== ======================================
1898
+ ``SystemIdentifier`` id Yes Unique identifier
1899
+ ``Location`` string See [#]_ No See [#]_ Location
1900
+ ``RatedAnnualkWh`` or ``extension/AdjustedAnnualkWh`` double kWh/yr > 0 No 319.8 [#]_ Annual consumption
1901
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
1902
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
1903
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
1904
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
1905
+ ===================================================== ====== ====== =========== ======== ========== ======================================
1906
+
1907
+ .. [#] 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".
1908
+ See :ref:`hpxmllocations` for descriptions.
1909
+ .. [#] If Location not provided, defaults to "garage" if present, otherwise "basement - unconditioned" if present, otherwise "basement - conditioned" if present, otherwise "living space".
1910
+ .. [#] RatedAnnualkWh default based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_.
1911
+ .. [#] 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".
1912
+ .. [#] 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".
1913
+
1914
+ HPXML Dehumidifier
1915
+ ******************
1916
+
1917
+ A single dehumidifier can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/Dehumidifier``.
1918
+
1919
+ ============================================== ========== ========== =========== ======== ======= ========================================
1920
+ Element Type Units Constraints Required Default Notes
1921
+ ============================================== ========== ========== =========== ======== ======= ========================================
1922
+ ``SystemIdentifier`` id Yes Unique identifier
1923
+ ``Type`` string See [#]_ Yes Type of dehumidifier
1924
+ ``Capacity`` double pints/day > 0 Yes Dehumidification capacity
1925
+ ``IntegratedEnergyFactor`` or ``EnergyFactor`` double liters/kWh > 0 Yes Rated efficiency
1926
+ ``DehumidistatSetpoint`` double frac 0-1 Yes Relative humidity setpoint
1927
+ ``FractionDehumidificationLoadServed`` double frac 0-1 Yes Fraction of dehumidification load served
1928
+ ============================================== ========== ========== =========== ======== ======= ========================================
1929
+
1930
+ .. [#] Type choices are "portable" or "whole-home".
1931
+
1932
+ HPXML Cooking Range/Oven
1933
+ ************************
1934
+
1935
+ A single cooking range can be entered as a ``/HPXML/Building/BuildingDetails/Appliances/CookingRange``.
1936
+
1937
+ ======================================== ======= ====== =========== ======== ============ ======================================
1938
+ Element Type Units Constraints Required Default Notes
1939
+ ======================================== ======= ====== =========== ======== ============ ======================================
1940
+ ``SystemIdentifier`` id Yes Unique identifier
1941
+ ``Location`` string See [#]_ No living space Location
1942
+ ``FuelType`` string See [#]_ Yes Fuel type
1943
+ ``IsInduction`` boolean No false Induction range?
1944
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on energy use
1945
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
1946
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
1947
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
1948
+ ======================================== ======= ====== =========== ======== ============ ======================================
1949
+
1950
+ .. [#] 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".
1951
+ See :ref:`hpxmllocations` for descriptions.
1952
+ .. [#] 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".
1953
+ .. [#] 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".
1954
+ .. [#] 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".
1955
+
1956
+ If a cooking range is specified, a single oven is also entered as a ``/HPXML/Building/BuildingDetails/Appliances/Oven``.
1957
+
1958
+ ==================== ======= ====== =========== ======== ======= ================
1959
+ Element Type Units Constraints Required Default Notes
1960
+ ==================== ======= ====== =========== ======== ======= ================
1961
+ ``SystemIdentifier`` id Yes Unique identifier
1962
+ ``IsConvection`` boolean No false Convection oven?
1963
+ ==================== ======= ====== =========== ======== ======= ================
1964
+
1965
+ HPXML Lighting & Ceiling Fans
1966
+ -----------------------------
1967
+
1968
+ Lighting and ceiling fans are entered in ``/HPXML/Building/BuildingDetails/Lighting``.
1969
+
1970
+ HPXML Lighting
1971
+ **************
1972
+
1973
+ If the building has lighting, nine ``/HPXML/Building/BuildingDetails/Lighting/LightingGroup`` elements must be provided, each of which is the combination of:
1974
+
1975
+ - ``LightingType``: 'LightEmittingDiode', 'CompactFluorescent', and 'FluorescentTube'
1976
+ - ``Location``: 'interior', 'garage', and 'exterior'
1977
+
1978
+ Information is entered in each ``LightingGroup``.
1979
+
1980
+ ============================= ======= ====== =========== ======== ======= ===========================================================================
1981
+ Element Type Units Constraints Required Default Notes
1982
+ ============================= ======= ====== =========== ======== ======= ===========================================================================
1983
+ ``SystemIdentifier`` id Yes Unique identifier
1984
+ ``LightingType`` element 1 [#]_ Yes Lighting type
1985
+ ``Location`` string See [#]_ Yes See [#]_
1986
+ ``FractionofUnitsInLocation`` double frac 0-1 [#]_ Yes Fraction of light fixtures in the location with the specified lighting type
1987
+ ============================= ======= ====== =========== ======== ======= ===========================================================================
1988
+
1989
+ .. [#] LightingType child element choices are ``LightEmittingDiode``, ``CompactFluorescent``, or ``FluorescentTube``.
1990
+ .. [#] Location choices are "interior", "garage", or "exterior".
1991
+ .. [#] Garage lighting is ignored if the building has no garage specified elsewhere.
1992
+ .. [#] The sum of FractionofUnitsInLocation for a given Location (e.g., interior) must be less than or equal to 1.
1993
+ If the fractions sum to less than 1, the remainder is assumed to be incandescent lighting.
1994
+
1995
+ Additional information is entered in ``Lighting``.
1996
+
1997
+ ================================================ ======= ====== =========== ======== ======== ===============================================
1998
+ Element Type Units Constraints Required Default Notes
1999
+ ================================================ ======= ====== =========== ======== ======== ===============================================
2000
+ ``extension/InteriorUsageMultiplier`` double >= 0 No 1.0 Multiplier on interior lighting use
2001
+ ``extension/GarageUsageMultiplier`` double >= 0 No 1.0 Multiplier on garage lighting use
2002
+ ``extension/ExteriorUsageMultiplier`` double >= 0 No 1.0 Multiplier on exterior lighting use
2003
+ ``extension/InteriorWeekdayScheduleFractions`` array No See [#]_ 24 comma-separated interior weekday fractions
2004
+ ``extension/InteriorWeekendScheduleFractions`` array No 24 comma-separated interior weekend fractions
2005
+ ``extension/InteriorMonthlyScheduleMultipliers`` array No 12 comma-separated interior monthly multipliers
2006
+ ``extension/GarageWeekdayScheduleFractions`` array No See [#]_ 24 comma-separated garage weekday fractions
2007
+ ``extension/GarageWeekendScheduleFractions`` array No 24 comma-separated garage weekend fractions
2008
+ ``extension/GarageMonthlyScheduleMultipliers`` array No 12 comma-separated garage monthly multipliers
2009
+ ``extension/ExteriorWeekdayScheduleFractions`` array No See [#]_ 24 comma-separated exterior weekday fractions
2010
+ ``extension/ExteriorWeekendScheduleFractions`` array No 24 comma-separated exterior weekend fractions
2011
+ ``extension/ExteriorMonthlyScheduleMultipliers`` array No 12 comma-separated exterior monthly multipliers
2012
+ ``extension/ExteriorHolidayLighting`` element 0-1 No <none> Presence of additional holiday lighting?
2013
+ ================================================ ======= ====== =========== ======== ======== ===============================================
2014
+
2015
+ .. [#] 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>`_.
2016
+ .. [#] 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>`_.
2017
+ .. [#] 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>`_.
2018
+
2019
+ If exterior holiday lighting is specified, additional information is entered in ``extension/ExteriorHolidayLighting``.
2020
+
2021
+ =============================== ======= ======= =========== ======== ============= ============================================
2022
+ Element Type Units Constraints Required Default Notes
2023
+ =============================== ======= ======= =========== ======== ============= ============================================
2024
+ ``Load[Units="kWh/day"]/Value`` double kWh/day >= 0 No See [#]_ Holiday lighting energy use per day
2025
+ ``PeriodBeginMonth`` integer 1-12 No 11 (November) Holiday lighting start date
2026
+ ``PeriodBeginDayOfMonth`` integer 1-31 No 24 Holiday lighting start date
2027
+ ``PeriodEndMonth`` integer 1-12 No 1 (January) Holiday lighting end date
2028
+ ``PeriodEndDayOfMonth`` integer 1-31 No 6 Holiday lighting end date
2029
+ ``WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated holiday weekday fractions
2030
+ ``WeekendScheduleFractions`` array No 24 comma-separated holiday weekend fractions
2031
+ =============================== ======= ======= =========== ======== ============= ============================================
2032
+
2033
+ .. [#] If Value not provided, defaults to 1.1 for single-family detached and 0.55 for others.
2034
+ .. [#] 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".
2035
+
2036
+ HPXML Ceiling Fans
2037
+ ******************
2038
+
2039
+ Each ceiling fan is entered as a ``/HPXML/Building/BuildingDetails/Lighting/CeilingFan``.
2040
+
2041
+ ========================================= ======= ======= =========== ======== ======== ==============================
2042
+ Element Type Units Constraints Required Default Notes
2043
+ ========================================= ======= ======= =========== ======== ======== ==============================
2044
+ ``SystemIdentifier`` id Yes Unique identifier
2045
+ ``Airflow[FanSpeed="medium"]/Efficiency`` double cfm/W > 0 No See [#]_ Efficiency at medium speed
2046
+ ``Quantity`` integer > 0 No See [#]_ Number of similar ceiling fans
2047
+ ========================================= ======= ======= =========== ======== ======== ==============================
2048
+
2049
+ .. [#] If Efficiency not provided, defaults to 3000 / 42.6 based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2050
+ .. [#] If Quantity not provided, defaults to NumberofBedrooms + 1 based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_.
2051
+
2052
+ .. note::
2053
+
2054
+ A reduced cooling setpoint can be specified for summer months when ceiling fans are operating.
2055
+ See :ref:`hvac_control` for more information.
2056
+
2057
+ HPXML Pools & Hot Tubs
2058
+ ----------------------
2059
+
2060
+ HPXML Pools
2061
+ ***********
2062
+
2063
+ A single pool can be entered as a ``/HPXML/Building/BuildingDetails/Pools/Pool``.
2064
+
2065
+ ==================== ======= ====== =========== ======== ============ =================
2066
+ Element Type Units Constraints Required Default Notes
2067
+ ==================== ======= ====== =========== ======== ============ =================
2068
+ ``SystemIdentifier`` id Yes Unique identifier
2069
+ ==================== ======= ====== =========== ======== ============ =================
2070
+
2071
+ Pool Pump
2072
+ ~~~~~~~~~
2073
+
2074
+ If a pool is specified, a single pool pump must be entered as a ``Pool/PoolPumps/PoolPump``.
2075
+
2076
+ ======================================== ======= ====== =========== ======== ============ ======================================
2077
+ Element Type Units Constraints Required Default Notes
2078
+ ======================================== ======= ====== =========== ======== ============ ======================================
2079
+ ``SystemIdentifier`` id Yes Unique identifier
2080
+ ``Load[Units="kWh/year"]/Value`` double kWh/yr >= 0 No See [#]_ Pool pump energy use
2081
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on pool pump energy use
2082
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2083
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2084
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2085
+ ======================================== ======= ====== =========== ======== ============ ======================================
2086
+
2087
+ .. [#] 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).
2088
+ .. [#] 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".
2089
+ .. [#] 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".
2090
+
2091
+ Pool Heater
2092
+ ~~~~~~~~~~~
2093
+
2094
+ If a pool is specified, a pool heater can be entered as a ``Pool/Heater``.
2095
+
2096
+ ====================================================== ======= ================== =========== ======== ======== ======================================
2097
+ Element Type Units Constraints Required Default Notes
2098
+ ====================================================== ======= ================== =========== ======== ======== ======================================
2099
+ ``SystemIdentifier`` id Yes Unique identifier
2100
+ ``Type`` string See [#]_ Yes Pool heater type
2101
+ ``Load[Units="kWh/year" or Units="therm/year"]/Value`` double kWh/yr or therm/yr >= 0 No See [#]_ Pool heater energy use
2102
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on pool heater energy use
2103
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2104
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2105
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2106
+ ====================================================== ======= ================== =========== ======== ======== ======================================
2107
+
2108
+ .. [#] Type choices are "gas fired", "electric resistance", or "heat pump".
2109
+ .. [#] If Value not provided, defaults as follows:
2110
+
2111
+ - **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>`_)
2112
+ - **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>`_)
2113
+ - **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>`_)
2114
+
2115
+ .. [#] 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".
2116
+ .. [#] 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".
2117
+
2118
+ HPXML Hot Tubs
2119
+ **************
2120
+
2121
+ A single hot tub can be entered as a ``/HPXML/Building/BuildingDetails/HotTubs/HotTub``.
2122
+
2123
+ ==================== ======= ====== =========== ======== ============ =================
2124
+ Element Type Units Constraints Required Default Notes
2125
+ ==================== ======= ====== =========== ======== ============ =================
2126
+ ``SystemIdentifier`` id Yes Unique identifier
2127
+ ==================== ======= ====== =========== ======== ============ =================
2128
+
2129
+ Hot Tub Pump
2130
+ ~~~~~~~~~~~~
2131
+
2132
+ If a hot tub is specified, a single hot tub pump must be entered as a ``HotTub/HotTubPumps/HotTubPump``.
2133
+
2134
+ ======================================== ======= ====== =========== ======== ============ ======================================
2135
+ Element Type Units Constraints Required Default Notes
2136
+ ======================================== ======= ====== =========== ======== ============ ======================================
2137
+ ``SystemIdentifier`` id Yes Unique identifier
2138
+ ``Load[Units="kWh/year"]/Value`` double kWh/yr >= 0 No See [#]_ Hot tub pump energy use
2139
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on hot tub pump energy use
2140
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2141
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2142
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2143
+ ======================================== ======= ====== =========== ======== ============ ======================================
2144
+
2145
+ .. [#] 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).
2146
+ .. [#] 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".
2147
+ .. [#] 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".
2148
+
2149
+ Hot Tub Heater
2150
+ ~~~~~~~~~~~~~~
2151
+
2152
+ If a hot tub is specified, a hot tub heater can be entered as a ``HotTub/Heater``.
2153
+
2154
+ ====================================================== ======= ================== =========== ======== ======== =======================================
2155
+ Element Type Units Constraints Required Default Notes
2156
+ ====================================================== ======= ================== =========== ======== ======== =======================================
2157
+ ``SystemIdentifier`` id Yes Unique identifier
2158
+ ``Type`` string See [#]_ Yes Hot tub heater type
2159
+ ``Load[Units="kWh/year" or Units="therm/year"]/Value`` double kWh/yr or therm/yr >= 0 No See [#]_ Hot tub heater energy use
2160
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on hot tub heater energy use
2161
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2162
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2163
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2164
+ ====================================================== ======= ================== =========== ======== ======== =======================================
2165
+
2166
+ .. [#] Type choices are "gas fired", "electric resistance", or "heat pump".
2167
+ .. [#] If Value not provided, defaults as follows:
2168
+
2169
+ - **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>`_)
2170
+ - **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>`_)
2171
+ - **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>`_)
2172
+
2173
+ .. [#] 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".
2174
+ .. [#] 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".
2175
+
2176
+ HPXML Misc Loads
2177
+ ----------------
2178
+
2179
+ Miscellaneous loads are entered in ``/HPXML/Building/BuildingDetails/MiscLoads``.
2180
+
2181
+ HPXML Plug Loads
2182
+ ****************
2183
+
2184
+ Each type of plug load can be entered as a ``/HPXML/Building/BuildingDetails/MiscLoads/PlugLoad``.
2185
+ It is required that at least a miscellaneous plug load (PlugLoadType="other") is specified to represent all residual plug loads not explicitly captured elsewhere.
2186
+
2187
+ ======================================== ======= ====== =========== ======== ======== =============================================================
2188
+ Element Type Units Constraints Required Default Notes
2189
+ ======================================== ======= ====== =========== ======== ======== =============================================================
2190
+ ``SystemIdentifier`` id Yes Unique identifier
2191
+ ``PlugLoadType`` string See [#]_ Yes Type of plug load
2192
+ ``Load[Units="kWh/year"]/Value`` double kWh/yr >= 0 No See [#]_ Annual electricity consumption
2193
+ ``extension/FracSensible`` double 0-1 No See [#]_ Fraction that is sensible heat gain to conditioned space [#]_
2194
+ ``extension/FracLatent`` double 0-1 No See [#]_ Fraction that is latent heat gain to conditioned space
2195
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on electricity use
2196
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2197
+ ``extension/WeekendScheduleFractions`` array No See [#]_ 24 comma-separated weekend fractions
2198
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2199
+ ======================================== ======= ====== =========== ======== ======== =============================================================
2200
+
2201
+ .. [#] PlugLoadType choices are "other", "TV other", "well pump", or "electric vehicle charging".
2202
+ .. [#] If Value not provided, defaults as:
2203
+
2204
+ - **other**: 0.91 * ConditionedFloorArea (based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_)
2205
+ - **TV other**: 413.0 + 69.0 * NumberofBedrooms (based on `ANSI/RESNET/ICC 301-2019 <https://codes.iccsafe.org/content/RESNETICC3012019>`_)
2206
+ - **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>`_)
2207
+ - **electric vehicle charging**: 1666.67 (calculated using AnnualMiles * kWhPerMile / (ChargerEfficiency * BatteryEfficiency) where AnnualMiles=4500, kWhPerMile=0.3, ChargerEfficiency=0.9, and BatteryEfficiency=0.9)
2208
+
2209
+ .. [#] If FracSensible not provided, defaults as:
2210
+
2211
+ - **other**: 0.855
2212
+ - **TV other**: 1.0
2213
+ - **well pump**: 0.0
2214
+ - **electric vehicle charging**: 0.0
2215
+
2216
+ .. [#] The remaining fraction (i.e., 1.0 - FracSensible - FracLatent) is assumed to be heat gain outside conditioned space and thus lost.
2217
+ .. [#] If FracLatent not provided, defaults as:
2218
+
2219
+ - **other**: 0.045
2220
+ - **TV other**: 0.0
2221
+ - **well pump**: 0.0
2222
+ - **electric vehicle charging**: 0.0
2223
+
2224
+ .. [#] If WeekdayScheduleFractions not provided, defaults as:
2225
+
2226
+ - **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>`_)
2227
+ - **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>`_)
2228
+ - **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>`_)
2229
+ - **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"
2230
+
2231
+ .. [#] If WeekdendScheduleFractions not provided, defaults as:
2232
+
2233
+ - **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>`_)
2234
+ - **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>`_)
2235
+ - **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>`_)
2236
+ - **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"
2237
+
2238
+ .. [#] If MonthlyScheduleMultipliers not provided, defaults as:
2239
+
2240
+ - **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>`_)
2241
+ - **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>`_)
2242
+ - **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>`_)
2243
+ - **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"
2244
+
2245
+ HPXML Fuel Loads
2246
+ ****************
2247
+
2248
+ Each fuel load can be entered as a ``/HPXML/Building/BuildingDetails/MiscLoads/FuelLoad``.
2249
+
2250
+ ======================================== ======= ======== =========== ======== ======== =============================================================
2251
+ Element Type Units Constraints Required Default Notes
2252
+ ======================================== ======= ======== =========== ======== ======== =============================================================
2253
+ ``SystemIdentifier`` id Yes Unique identifier
2254
+ ``FuelLoadType`` string See [#]_ Yes Type of fuel load
2255
+ ``Load[Units="therm/year"]/Value`` double therm/yr >= 0 No See [#]_ Annual fuel consumption
2256
+ ``FuelType`` string See [#]_ Yes Fuel type
2257
+ ``extension/FracSensible`` double 0-1 No See [#]_ Fraction that is sensible heat gain to conditioned space [#]_
2258
+ ``extension/FracLatent`` double 0-1 No See [#]_ Fraction that is latent heat gain to conditioned space
2259
+ ``extension/UsageMultiplier`` double >= 0 No 1.0 Multiplier on fuel use
2260
+ ``extension/WeekdayScheduleFractions`` array No See [#]_ 24 comma-separated weekday fractions
2261
+ ``extension/WeekendScheduleFractions`` array No 24 comma-separated weekend fractions
2262
+ ``extension/MonthlyScheduleMultipliers`` array No See [#]_ 12 comma-separated monthly multipliers
2263
+ ======================================== ======= ======== =========== ======== ======== =============================================================
2264
+
2265
+ .. [#] FuelLoadType choices are "grill", "fireplace", or "lighting".
2266
+ .. [#] If Value not provided, calculated as based on the `2010 BAHSP <https://www1.eere.energy.gov/buildings/publications/pdfs/building_america/house_simulation.pdf>`_:
2267
+
2268
+ - **grill**: 0.87 / 0.029 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920)
2269
+ - **fireplace**: 1.95 / 0.032 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920)
2270
+ - **lighting**: 0.22 / 0.012 * (0.5 + 0.25 * NumberofBedrooms / 3 + 0.35 * ConditionedFloorArea / 1920)
2271
+
2272
+ .. [#] 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".
2273
+ .. [#] If FracSensible not provided, defaults to 0.5 for fireplace and 0.0 for all other types.
2274
+ .. [#] The remaining fraction (i.e., 1.0 - FracSensible - FracLatent) is assumed to be heat gain outside conditioned space and thus lost.
2275
+ .. [#] If FracLatent not provided, defaults to 0.1 for fireplace and 0.0 for all other types.
2276
+ .. [#] 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:
2277
+
2278
+ - **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";
2279
+ - **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";
2280
+ - **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".
2281
+
2282
+ .. [#] 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:
2283
+
2284
+ - **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";
2285
+ - **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";
2286
+ - **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".
2287
+
2288
+ .. _hpxmllocations:
2289
+
2290
+ HPXML Locations
2291
+ ---------------
2292
+
2293
+ The various locations used in an HPXML file are defined as follows:
2294
+
2295
+ ============================== =========================================== ======================================= =============
2296
+ Value Description Temperature Building Type
2297
+ ============================== =========================================== ======================================= =============
2298
+ outside Ambient environment Weather data Any
2299
+ ground EnergyPlus calculation Any
2300
+ living space Above-grade conditioned floor area EnergyPlus calculation Any
2301
+ attic - vented EnergyPlus calculation Any
2302
+ attic - unvented EnergyPlus calculation Any
2303
+ basement - conditioned Below-grade conditioned floor area EnergyPlus calculation Any
2304
+ basement - unconditioned EnergyPlus calculation Any
2305
+ crawlspace - vented EnergyPlus calculation Any
2306
+ crawlspace - unvented EnergyPlus calculation Any
2307
+ garage Single-family garage (not shared parking) EnergyPlus calculation Any
2308
+ other housing unit E.g., conditioned adjacent unit or corridor Same as living space SFA/MF only
2309
+ other heated space E.g., shared laundry/equipment space Avg of living space/outside; min of 68F SFA/MF only
2310
+ other multifamily buffer space E.g., enclosed unconditioned stairwell Avg of living space/outside; min of 50F SFA/MF only
2311
+ other non-freezing space E.g., shared parking garage ceiling Floats with outside; minimum of 40F SFA/MF only
2312
+ other exterior Water heater outside Weather data Any
2313
+ exterior wall Ducts in exterior wall Avg of living space/outside Any
2314
+ under slab Ducts under slab (ground) EnergyPlus calculation Any
2315
+ roof deck Ducts on roof deck (outside) Weather data Any
2316
+ ============================== =========================================== ======================================= =============
2317
+
2318
+ Validating & Debugging Errors
2319
+ -----------------------------
2320
+
2321
+ When running HPXML files, errors may occur because:
2322
+
2323
+ #. An HPXML file provided is invalid (either relative to the HPXML schema or the EnergyPlus Use Case).
2324
+ #. An unexpected EnergyPlus simulation error occurred.
2325
+
2326
+ If an error occurs, first look in the run.log for details.
2327
+ If there are no errors in that log file, then the error may be in the EnergyPlus simulation -- see eplusout.err.
2328
+
2329
+ Contact us if you can't figure out the cause of an error.
2330
+
2331
+ Sample Files
2332
+ ------------
2333
+
2334
+ Dozens of sample HPXML files are included in the workflow/sample_files directory.
2335
+ The sample files help to illustrate how different building components are described in HPXML.
2336
+
2337
+ Each sample file generally makes one isolated change relative to the base HPXML (base.xml) building.
2338
+ For example, the base-dhw-dwhr.xml file adds a ``DrainWaterHeatRecovery`` element to the building.
2339
+
2340
+ 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.