Merge pull request #1103 from NREL/latest-os-hpxml

Latest OS-HPXML

docs/read_the_docs/source/workflow_outputs/csv_tables.rb

@@ -8,7 +8,7 @@
 csv_tables = {
   'characteristics.csv' => { 'annual' => false, 'timeseries' => false, 'kws' => ['build_existing_model.'], 'usecols' => ['Input Name', 'Input Description'] },
   'other_outputs.csv' => { 'annual' => false, 'timeseries' => false, 'kws' => ['build_existing_model.'], 'usecols' => ['Input Name', 'Input Description'] },
-  'simulation_outputs.csv' => { 'annual' => true, 'timeseries' => true, 'kws' => ['.end_use_', '.energy_use_', 'fuel_use_', '.hot_water_', '.hvac_capacity_', '.hvac_design_', '.load_', '.peak_', '.unmet_hours_'], 'usecols' => ['Annual Name', 'Annual Units', 'Timeseries ResStock Name', 'Timeseries BuildStockBatch Name', 'Timeseries Units', 'Notes'] },
+  'simulation_outputs.csv' => { 'annual' => true, 'timeseries' => true, 'kws' => ['.end_use_', '.energy_use_', 'fuel_use_', '.hot_water_', '.hvac_capacity_', '.hvac_design_', '.load_', '.peak_', '.resilience_', '.unmet_hours_'], 'usecols' => ['Annual Name', 'Annual Units', 'Timeseries ResStock Name', 'Timeseries BuildStockBatch Name', 'Timeseries Units', 'Notes'] },
   'cost_multipliers.csv' => { 'annual' => true, 'timeseries' => false, 'kws' => ['upgrade_costs.'], 'usecols' => ['Annual Name', 'Annual Units', 'Notes'] },
   'component_loads.csv' => { 'annual' => true, 'timeseries' => true, 'kws' => ['.component_load_'], 'usecols' => ['Annual Name', 'Annual Units', 'Timeseries ResStock Name', 'Timeseries BuildStockBatch Name', 'Timeseries Units', 'Notes'] },
   'emissions.csv' => { 'annual' => true, 'timeseries' => true, 'kws' => ['.emissions_'], 'usecols' => ['Annual Name', 'Annual Units', 'Timeseries ResStock Name', 'Timeseries BuildStockBatch Name', 'Timeseries Units', 'Notes'] },

docs/read_the_docs/source/workflow_outputs/csv_tables/other_outputs.csv

@@ -64,6 +64,7 @@ report_simulation_output.include_annual_peak_loads,Generates annual peak loads f
 report_simulation_output.include_annual_component_loads,Generates annual heating and cooling loads disaggregated by component type.
 report_simulation_output.include_annual_hot_water_uses,Generates annual hot water usages for each end use.
 report_simulation_output.include_annual_hvac_summary,"Generates HVAC capacities, design temperatures, and design loads."
+report_simulation_output.include_annual_resilience,Generates annual resilience outputs.
 report_simulation_output.include_timeseries_total_consumptions,Generates timeseries energy consumptions for the total building.
 report_simulation_output.include_timeseries_fuel_consumptions,Generates timeseries energy consumptions for each fuel type.
 report_simulation_output.include_timeseries_end_use_consumptions,Generates timeseries energy consumptions for each end use.
@@ -78,13 +79,17 @@ report_simulation_output.include_timeseries_unmet_hours,Generates timeseries unm
 report_simulation_output.include_timeseries_zone_temperatures,Generates timeseries temperatures for each thermal zone.
 report_simulation_output.include_timeseries_airflows,Generates timeseries airflows.
 report_simulation_output.include_timeseries_weather,Generates timeseries weather data.
+report_simulation_output.include_timeseries_resilience,Generates timeseries resilience outputs.
 report_simulation_output.timeseries_timestamp_convention,Determines whether timeseries timestamps use the start-of-period or end-of-period convention. Doesn't apply if the output format is 'csv_dview'.
 report_simulation_output.timeseries_num_decimal_places,"Allows overriding the default number of decimal places for timeseries output. Does not apply if output format is msgpack, where no rounding is performed because there is no file size penalty to storing full precision."
 report_simulation_output.add_timeseries_dst_column,"Optionally add, in addition to the default local standard Time column, a local clock TimeDST column. Requires that daylight saving time is enabled."
 report_simulation_output.add_timeseries_utc_column,"Optionally add, in addition to the default local standard Time column, a local clock TimeUTC column. If the time zone UTC offset is not provided in the HPXML file, the time zone in the EPW header will be used."
 report_simulation_output.user_output_variables,"Optionally generates timeseries EnergyPlus output variables. If multiple output variables are desired, use a comma-separated list. Do not include key values; by default all key values will be requested. Example: ""Zone People Occupant Count, Zone People Total Heating Energy"""
 report_utility_bills.applicable,The measure was applied to the workflow.
 report_utility_bills.output_format,"The file format of the annual (and timeseries, if requested) outputs."
+report_utility_bills.include_annual_bills,Generates annual utility bills.
+report_utility_bills.include_monthly_bills,Generates monthly utility bills.
+report_utility_bills.monthly_timestamp_convention,Determines whether monthly timestamps use the start-of-period or end-of-period convention.
 upgrade_costs.applicable,The measure was applied to the workflow.
 upgrade_costs.debug,"If true, retain existing and upgraded intermediate files."
 upgrade_costs.upgrade_cost_usd,Total cost of the upgrade.

docs/read_the_docs/source/workflow_outputs/csv_tables/qoi_report.csv

@@ -12,5 +12,5 @@ qoi_report.qoi_average_of_top_ten_highest_peaks_timing_cooling_hour,hr,The avera
 qoi_report.qoi_average_of_top_ten_highest_peaks_timing_heating_hour,hr,The average hour (average daily index) for which the total site electricity average of top 10 maximum daily use occurs during the heating season.
 qoi_report.qoi_average_of_top_ten_highest_peaks_use_cooling_kw,kW,The total site electricity average of top 10 maximum daily use during the cooling season (days with average outdoor air drybulb temperature greater than 70F).
 qoi_report.qoi_average_of_top_ten_highest_peaks_use_heating_kw,kW,The total site electricity average of top 10 maximum daily use during the heating season (days with average outdoor air drybulb temperature less than 55F).
-qoi_report.qoi_peak_magnitude_timing_hour,hr,The hour (annual index) for which the total site electricity annual peak use occurs.
-qoi_report.qoi_peak_magnitude_use_kw,kW,The total site electricity annual peak use (maximum value).
+qoi_report.qoi_hourly_peak_magnitude_timing_hour,hr,The hour (annual index) for which the total site electricity annual peak use occurs.
+qoi_report.qoi_hourly_peak_magnitude_use_kw,kW,The total site electricity annual peak use (maximum value).

docs/read_the_docs/source/workflow_outputs/csv_tables/simulation_outputs.csv

@@ -149,9 +149,11 @@ report_simulation_output.load_hot_water_delivered_m_btu,MBtu,Load: Hot Water: De
 report_simulation_output.load_hot_water_desuperheater_m_btu,MBtu,Load: Hot Water: Desuperheater,load__hot_water__desuperheater__kbtu,kBtu,Load served by the desuperheater.
 report_simulation_output.load_hot_water_solar_thermal_m_btu,MBtu,Load: Hot Water: Solar Thermal,load__hot_water__solar_thermal__kbtu,kBtu,Load served by the solar thermal system.
 report_simulation_output.load_hot_water_tank_losses_m_btu,MBtu,Load: Hot Water: Tank Losses,load__hot_water__tank_losses__kbtu,kBtu,
+report_simulation_output.peak_electricity_annual_total_w,W,,,,Maximum value in any month
 report_simulation_output.peak_electricity_summer_total_w,W,,,,Maximum value in Jun/Jul/Aug (or Dec/Jan/Feb in the southern hemisphere)
 report_simulation_output.peak_electricity_winter_total_w,W,,,,Maximum value in Dec/Jan/Feb (or Jun/Jul/Aug in the southern hemisphere)
 report_simulation_output.peak_load_cooling_delivered_k_btu_hr,kBtu/hr,,,,Includes HVAC distribution losses.
 report_simulation_output.peak_load_heating_delivered_k_btu_hr,kBtu/hr,,,,Includes HVAC distribution losses.
+report_simulation_output.resilience_battery_hr,hr,Resilience: Battery,resilience__battery__hr,hr,Average length of time the battery state of charge can meet the electric load
 report_simulation_output.unmet_hours_cooling_hr,hr,Unmet Hours: Cooling,unmet_hours__cooling__hr,hr,Number of hours where the cooling setpoint is not maintained.
 report_simulation_output.unmet_hours_heating_hr,hr,Unmet Hours: Heating,unmet_hours__heating__hr,hr,Number of hours where the heating setpoint is not maintained.

measures/QOIReport/measure.rb

@@ -92,10 +92,10 @@ def run(runner, user_arguments)
     end
 
     # Peak magnitude (1)
-    report_sim_output(runner, 'qoi_peak_magnitude_use_kw', use(timeseries, [-1e9, 1e9], 'max'), '', '')
+    report_sim_output(runner, 'qoi_hourly_peak_magnitude_use_kw', use(timeseries, [-1e9, 1e9], 'max'), '', '')
 
     # Timing of peak magnitude (1)
-    report_sim_output(runner, 'qoi_peak_magnitude_timing_hour', timing(timeseries, [-1e9, 1e9], 'max'), '', '')
+    report_sim_output(runner, 'qoi_hourly_peak_magnitude_timing_hour', timing(timeseries, [-1e9, 1e9], 'max'), '', '')
 
     # Average daily base magnitude (by season) (3)
     seasons.each do |season, temperature_range|

measures/QOIReport/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>qoi_report</name>
   <uid>be0bfc7f-25c6-435a-9acd-2f5fa8ac817d</uid>
-  <version_id>f5af7f98-7101-4780-8fd7-0b4246505fc1</version_id>
-  <version_modified>20230501T221656Z</version_modified>
+  <version_id>37ef3716-cf1a-4fa0-a1f2-958125cd3669</version_id>
+  <version_modified>2023-07-17T17:11:48Z</version_modified>
   <xml_checksum>15BF4E57</xml_checksum>
   <class_name>QOIReport</class_name>
   <display_name>QOI Report</display_name>
@@ -24,6 +24,17 @@
     </attribute>
   </attributes>
   <files>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.9.0</identifier>
+        <min_compatible>2.9.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>895E5871</checksum>
+    </file>
     <file>
       <filename>constants.rb</filename>
       <filetype>rb</filetype>
@@ -36,16 +47,5 @@
       <usage_type>test</usage_type>
       <checksum>FDE812FB</checksum>
     </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.9.0</identifier>
-        <min_compatible>2.9.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>48961FEB</checksum>
-    </file>
   </files>
 </measure>

measures/UpgradeCosts/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>upgrade_costs</name>
   <uid>ef51212c-acc4-48d7-9b29-cf2a5c6c4449</uid>
-  <version_id>c08d5898-10f4-4e59-8819-1a765bb3b13e</version_id>
-  <version_modified>2023-06-28T20:58:10Z</version_modified>
+  <version_id>21848d6d-6b88-4008-ad94-8295b7bf99ff</version_id>
+  <version_modified>2023-07-17T22:56:13Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>UpgradeCosts</class_name>
   <display_name>Upgrade Costs</display_name>
@@ -141,7 +141,7 @@
       <filename>SFD_1story_UB_UA_GRG_ACV_FuelFurnace_PortableHeater_HPWH.osw</filename>
       <filetype>osw</filetype>
       <usage_type>test</usage_type>
-      <checksum>546A7C2B</checksum>
+      <checksum>ABFCA3DB</checksum>
     </file>
     <file>
       <filename>SFD_2story_CS_UA_AC2_FuelBoiler_FuelTankWH.osw</filename>
@@ -165,7 +165,7 @@
       <filename>SFD_2story_FB_UA_GRG_AC1_UnitHeater_FuelTankWH.osw</filename>
       <filetype>osw</filetype>
       <usage_type>test</usage_type>
-      <checksum>6C58B3A3</checksum>
+      <checksum>3D409CCE</checksum>
     </file>
     <file>
       <filename>SFD_2story_FB_UA_GRG_GSHP_ElecTanklessWH.osw</filename>

measures/UpgradeCosts/tests/SFD_1story_UB_UA_GRG_ACV_FuelFurnace_PortableHeater_HPWH.osw

@@ -148,7 +148,7 @@
         "heating_system_heating_efficiency": 0.92,
         "heating_system_2_heating_efficiency": 1.0,
         "heating_system_type": "Furnace",
-        "heating_system_2_type": "PortableHeater",
+        "heating_system_2_type": "SpaceHeater",
         "holiday_lighting_present": false,
         "hot_tub_heater_type": "electric resistance",
         "hot_tub_heater_usage_multiplier": 1.0,

measures/UpgradeCosts/tests/SFD_2story_FB_UA_GRG_AC1_UnitHeater_FuelTankWH.osw

@@ -146,7 +146,7 @@
         "heating_system_heating_capacity": 100000.0,
         "heating_system_heating_efficiency": 0.92,
         "heating_system_2_heating_efficiency": 1.0,
-        "heating_system_type": "FixedHeater",
+        "heating_system_type": "SpaceHeater",
         "heating_system_2_type": "none",
         "holiday_lighting_present": false,
         "hot_tub_heater_type": "electric resistance",

resources/data/dictionary/inputs.csv

@@ -207,6 +207,7 @@ report_simulation_output.include_annual_peak_loads,Generates annual peak loads f
 report_simulation_output.include_annual_component_loads,Generates annual heating and cooling loads disaggregated by component type.
 report_simulation_output.include_annual_hot_water_uses,Generates annual hot water usages for each end use.
 report_simulation_output.include_annual_hvac_summary,"Generates HVAC capacities, design temperatures, and design loads."
+report_simulation_output.include_annual_resilience,Generates annual resilience outputs.
 report_simulation_output.include_timeseries_total_consumptions,Generates timeseries energy consumptions for the total building.
 report_simulation_output.include_timeseries_fuel_consumptions,Generates timeseries energy consumptions for each fuel type.
 report_simulation_output.include_timeseries_end_use_consumptions,Generates timeseries energy consumptions for each end use.
@@ -221,13 +222,17 @@ report_simulation_output.include_timeseries_unmet_hours,Generates timeseries unm
 report_simulation_output.include_timeseries_zone_temperatures,Generates timeseries temperatures for each thermal zone.
 report_simulation_output.include_timeseries_airflows,Generates timeseries airflows.
 report_simulation_output.include_timeseries_weather,Generates timeseries weather data.
+report_simulation_output.include_timeseries_resilience,Generates timeseries resilience outputs.
 report_simulation_output.timeseries_timestamp_convention,Determines whether timeseries timestamps use the start-of-period or end-of-period convention. Doesn't apply if the output format is 'csv_dview'.
 report_simulation_output.timeseries_num_decimal_places,"Allows overriding the default number of decimal places for timeseries output. Does not apply if output format is msgpack, where no rounding is performed because there is no file size penalty to storing full precision."
 report_simulation_output.add_timeseries_dst_column,"Optionally add, in addition to the default local standard Time column, a local clock TimeDST column. Requires that daylight saving time is enabled."
 report_simulation_output.add_timeseries_utc_column,"Optionally add, in addition to the default local standard Time column, a local clock TimeUTC column. If the time zone UTC offset is not provided in the HPXML file, the time zone in the EPW header will be used."
 report_simulation_output.user_output_variables,"Optionally generates timeseries EnergyPlus output variables. If multiple output variables are desired, use a comma-separated list. Do not include key values; by default all key values will be requested. Example: ""Zone People Occupant Count, Zone People Total Heating Energy"""
 report_utility_bills.applicable,The measure was applied to the workflow.
 report_utility_bills.output_format,"The file format of the annual (and timeseries, if requested) outputs."
+report_utility_bills.include_annual_bills,Generates annual utility bills.
+report_utility_bills.include_monthly_bills,Generates monthly utility bills.
+report_utility_bills.monthly_timestamp_convention,Determines whether monthly timestamps use the start-of-period or end-of-period convention.
 upgrade_costs.applicable,The measure was applied to the workflow.
 upgrade_costs.debug,"If true, retain existing and upgraded intermediate files."
 upgrade_costs.upgrade_cost_usd,Total cost of the upgrade.