urbanopt-cli 0.8.3 → 0.9.1

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