Latest OS-HPXML

docs/read_the_docs/source/workflow_inputs/characteristics.rst

@@ -1112,7 +1112,7 @@ Arguments
      - Total number of ceiling fans. If not provided, the OS-HPXML default (see `HPXML Ceiling Fans <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-ceiling-fans>`_) is used.
    * - ``ceiling_fan_cooling_setpoint_temp_offset``
      - false
-     - deg-F
+     - F
      - Double
      - auto
      - The cooling setpoint temperature offset during months when the ceiling fans are operating. Only applies if ceiling fan quantity is greater than zero. If not provided, the OS-HPXML default (see `HPXML Ceiling Fans <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-ceiling-fans>`_) is used.
@@ -38637,7 +38637,7 @@ Arguments
      - The output heating capacity of the heat pump at a user-specified temperature (e.g., 17F or 5F) divided by the above nominal heating capacity. Applies to all heat pump types except ground-to-air. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#air-to-air-heat-pump>`_, `Mini-Split Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#mini-split-heat-pump>`_, `Packaged Terminal Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#packaged-terminal-heat-pump>`_, `Room Air Conditioner w/ Reverse Cycle <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#room-air-conditioner-w-reverse-cycle>`_) is used.
    * - ``heat_pump_heating_capacity_retention_temp``
      - false
-     - deg-F
+     - F
      - Double
      -
      - The user-specified temperature (e.g., 17F or 5F) for the above heating capacity retention fraction. Applies to all heat pump types except ground-to-air. Required if the Heating Capacity Retention Fraction is provided.
@@ -38667,7 +38667,7 @@ Arguments
      - The cooling load served by the heat pump.
    * - ``heat_pump_compressor_lockout_temp``
      - false
-     - deg-F
+     - F
      - Double
      - auto
      - The temperature below which the heat pump compressor is disabled. If both this and Backup Heating Lockout Temperature are provided and use the same value, it essentially defines a switchover temperature (for, e.g., a dual-fuel heat pump). Applies to all heat pump types other than ground-to-air. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#air-to-air-heat-pump>`_, `Mini-Split Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#mini-split-heat-pump>`_, `Packaged Terminal Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#packaged-terminal-heat-pump>`_, `Room Air Conditioner w/ Reverse Cycle <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#room-air-conditioner-w-reverse-cycle>`_) is used.
@@ -38703,7 +38703,7 @@ Arguments
      - The backup output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Backup <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#backup>`_) is used. Only applies if Backup Type is 'integrated'.
    * - ``heat_pump_backup_heating_lockout_temp``
      - false
-     - deg-F
+     - F
      - Double
      - auto
      - The temperature above which the heat pump backup system is disabled. If both this and Compressor Lockout Temperature are provided and use the same value, it essentially defines a switchover temperature (for, e.g., a dual-fuel heat pump). Applies for both Backup Type of 'integrated' and 'separate'. If not provided, the OS-HPXML default (see `Backup <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#backup>`_) is used.
@@ -42794,30 +42794,36 @@ Arguments
      - Choice
      - auto, exposed, normal, well-shielded
      - Presence of nearby buildings, trees, obstructions for infiltration model. If not provided, the OS-HPXML default (see `HPXML Site <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-site>`_) is used.
+   * - ``air_leakage_leakiness_description``
+     - false
+     - 
+     - Choice
+     - auto, very tight, tight, average, leaky, very leaky
+     - Qualitative description of infiltration. If provided, the Year Built of the home is required. Either provide this input or provide a numeric air leakage value below.
    * - ``air_leakage_units``
-     - true
+     - false
      - 
      - Choice
-     - ACH, CFM, ACHnatural, CFMnatural, EffectiveLeakageArea
-     - The unit of measure for the air leakage.
+     - auto, ACH, CFM, ACHnatural, CFMnatural, EffectiveLeakageArea
+     - The unit of measure for the air leakage if providing a numeric air leakage value.
    * - ``air_leakage_house_pressure``
-     - true
+     - false
      - Pa
      - Double
      -
-     - The house pressure relative to outside. Required when units are ACH or CFM.
+     - The house pressure relative to outside if providing a numeric air leakage value. Required when units are ACH or CFM.
    * - ``air_leakage_value``
-     - true
+     - false
      - 
      - Double
      -
-     - Air exchange rate value. For 'EffectiveLeakageArea', provide value in sq. in.
+     - Numeric air leakage value. For 'EffectiveLeakageArea', provide value in sq. in. If provided, overrides Leakiness Description input.
    * - ``air_leakage_type``
      - false
      - 
      - Choice
      - auto, unit total, unit exterior only
-     - Type of air leakage. If 'unit total', represents the total infiltration to the unit as measured by a compartmentalization test, in which case the air leakage value will be adjusted by the ratio of exterior envelope surface area to total envelope surface area. Otherwise, if 'unit exterior only', represents the infiltration to the unit from outside only as measured by a guarded test. Required when unit type is single-family attached or apartment unit.
+     - Type of air leakage if providing a numeric air leakage value. If 'unit total', represents the total infiltration to the unit as measured by a compartmentalization test, in which case the air leakage value will be adjusted by the ratio of exterior envelope surface area to total envelope surface area. Otherwise, if 'unit exterior only', represents the infiltration to the unit from outside only as measured by a guarded test. Required when unit type is single-family attached or apartment unit.
 
 Options
 *******
@@ -42832,6 +42838,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
    * - Option name
      - Stock saturation
      - ``site_shielding_of_home``
+     - ``air_leakage_leakiness_description``
      - ``air_leakage_units``
      - ``air_leakage_house_pressure``
      - ``air_leakage_value``
@@ -42840,104 +42847,119 @@ From ``project_national`` the list of options, option stock sturation, and optio
    * - 1 ACH50
      - 0.064%
      - normal
+     - auto
      - ACH
      - 50
      - 1
      - unit exterior only
    * - 2 ACH50
      - 0.66%
      - normal
+     - auto
      - ACH
      - 50
      - 2
      - unit exterior only
    * - 3 ACH50
      - 1.4%
      - normal
+     - auto
      - ACH
      - 50
      - 3
      - unit exterior only
    * - 4 ACH50
      - 2.3%
      - normal
+     - auto
      - ACH
      - 50
      - 4
      - unit exterior only
    * - 5 ACH50
      - 3.4%
      - normal
+     - auto
      - ACH
      - 50
      - 5
      - unit exterior only
    * - 6 ACH50
      - 4.3%
      - normal
+     - auto
      - ACH
      - 50
      - 6
      - unit exterior only
    * - 7 ACH50
      - 4.9%
      - normal
+     - auto
      - ACH
      - 50
      - 7
      - unit exterior only
    * - 8 ACH50
      - 5.3%
      - normal
+     - auto
      - ACH
      - 50
      - 8
      - unit exterior only
    * - 10 ACH50
      - 11%
      - normal
+     - auto
      - ACH
      - 50
      - 10
      - unit exterior only
    * - 15 ACH50
      - 24%
      - normal
+     - auto
      - ACH
      - 50
      - 15
      - unit exterior only
    * - 20 ACH50
      - 17%
      - normal
+     - auto
      - ACH
      - 50
      - 20
      - unit exterior only
    * - 25 ACH50
      - 10%
      - normal
+     - auto
      - ACH
      - 50
      - 25
      - unit exterior only
    * - 30 ACH50
      - 6.1%
      - normal
+     - auto
      - ACH
      - 50
      - 30
      - unit exterior only
    * - 40 ACH50
      - 5.7%
      - normal
+     - auto
      - ACH
      - 50
      - 40
      - unit exterior only
    * - 50 ACH50
      - 3.2%
      - normal
+     - auto
      - ACH
      - 50
      - 50
@@ -43527,7 +43549,7 @@ Arguments
      - Double
      -
      - Nominal R-value of the vertical slab perimeter insulation. Applies to slab-on-grade foundations and basement/crawlspace floors.
-   * - ``slab_perimeter_depth``
+   * - ``slab_perimeter_insulation_depth``
      - true
      - ft
      - Double
@@ -43539,7 +43561,7 @@ Arguments
      - Double
      -
      - Nominal R-value of the horizontal under slab insulation. Applies to slab-on-grade foundations and basement/crawlspace floors.
-   * - ``slab_under_width``
+   * - ``slab_under_insulation_width``
      - true
      - ft
      - Double
@@ -43577,9 +43599,9 @@ From ``project_national`` the list of options, option stock sturation, and optio
    * - Option name
      - Stock saturation
      - ``slab_perimeter_insulation_r``
-     - ``slab_perimeter_depth``
+     - ``slab_perimeter_insulation_depth``
      - ``slab_under_insulation_r``
-     - ``slab_under_width``
+     - ``slab_under_insulation_width``
      - ``slab_thickness``
      - ``slab_carpet_fraction``
      - ``slab_carpet_r``
@@ -46451,7 +46473,7 @@ Arguments
      - kWh/yr
      - Double
      - auto
-     - The EnergyGuide rated annual energy consumption for an extra rrefrigerator. If not provided, the OS-HPXML default (see `HPXML Refrigerators <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-refrigerators>`_) is used.
+     - The EnergyGuide rated annual energy consumption for an extra refrigerator. If not provided, the OS-HPXML default (see `HPXML Refrigerators <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-refrigerators>`_) is used.
    * - ``extra_refrigerator_usage_multiplier``
      - false
      - 
@@ -62542,7 +62564,7 @@ Arguments
      - Heating capacity. Only applies to storage water heater. If not provided, the OS-HPXML default (see `Conventional Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage>`_) is used.
    * - ``water_heater_standby_loss``
      - false
-     - deg-F/hr
+     - F/hr
      - Double
      - auto
      - The standby loss of water heater. Only applies to space-heating boilers. If not provided, the OS-HPXML default (see `Combi Boiler w/ Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage>`_) is used.
@@ -62554,7 +62576,7 @@ Arguments
      - The jacket R-value of water heater. Doesn't apply to instantaneous water heater or space-heating boiler with tankless coil. If not provided, defaults to no jacket insulation.
    * - ``water_heater_setpoint_temperature``
      - false
-     - deg-F
+     - F
      - Double
      - auto
      - The setpoint temperature of water heater. If not provided, the OS-HPXML default (see `HPXML Water Heating Systems <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-water-heating-systems>`_) is used.

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

@@ -119,6 +119,7 @@ report_simulation_output.hvac_design_load_cooling_latent_internal_gains_btu_h,Bt
 report_simulation_output.hvac_design_load_cooling_latent_total_btu_h,Btu/h,,,,Total latent cooling design load
 report_simulation_output.hvac_design_load_cooling_latent_ventilation_btu_h,Btu/h,,,,Latent cooling design load for ventilation
 report_simulation_output.hvac_design_load_cooling_sensible_aed_excursion_btu_h,Btu/h,,,,Sensible cooling design load for Adequate Exposure Diversity (AED) excursion
+report_simulation_output.hvac_design_load_cooling_sensible_blower_heat_btu_h,Btu/h,,,,Sensible cooling design load for blower fan heat
 report_simulation_output.hvac_design_load_cooling_sensible_ceilings_btu_h,Btu/h,,,,Sensible cooling design load for ceilings
 report_simulation_output.hvac_design_load_cooling_sensible_doors_btu_h,Btu/h,,,,Sensible cooling design load for doors
 report_simulation_output.hvac_design_load_cooling_sensible_ducts_btu_h,Btu/h,,,,Sensible cooling design load for ducts
@@ -137,11 +138,12 @@ report_simulation_output.hvac_design_load_heating_doors_btu_h,Btu/h,,,,Heating d
 report_simulation_output.hvac_design_load_heating_ducts_btu_h,Btu/h,,,,Heating design load for ducts
 report_simulation_output.hvac_design_load_heating_floors_btu_h,Btu/h,,,,Heating design load for floors
 report_simulation_output.hvac_design_load_heating_infiltration_btu_h,Btu/h,,,,Heating design load for infiltration
-report_simulation_output.hvac_design_load_heating_ventilation_btu_h,Btu/h,,,,Heating design load for ventilation
+report_simulation_output.hvac_design_load_heating_piping_btu_h,Btu/h,,,,Heating design load for hydronic piping
 report_simulation_output.hvac_design_load_heating_roofs_btu_h,Btu/h,,,,Heating design load for roofs
 report_simulation_output.hvac_design_load_heating_skylights_btu_h,Btu/h,,,,Heating design load for skylights
 report_simulation_output.hvac_design_load_heating_slabs_btu_h,Btu/h,,,,Heating design load for slabs
 report_simulation_output.hvac_design_load_heating_total_btu_h,Btu/h,,,,Total heating design load
+report_simulation_output.hvac_design_load_heating_ventilation_btu_h,Btu/h,,,,Heating design load for ventilation
 report_simulation_output.hvac_design_load_heating_walls_btu_h,Btu/h,,,,Heating design load for walls
 report_simulation_output.hvac_design_load_heating_windows_btu_h,Btu/h,,,,Heating design load for windows
 report_simulation_output.hvac_design_temperature_cooling_f,F,,,,1% cooling drybulb temperature

measures/ApplyUpgrade/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>apply_upgrade</name>
   <uid>33f1654c-f734-43d1-b35d-9d2856e41b5a</uid>
-  <version_id>d64434ad-c449-4217-b012-6d38db112a62</version_id>
-  <version_modified>2024-05-30T15:24:23Z</version_modified>
+  <version_id>d19f6a58-0cef-4930-99fa-bc2253537cae</version_id>
+  <version_modified>2024-07-11T16:34:35Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>ApplyUpgrade</class_name>
   <display_name>Apply Upgrade</display_name>
@@ -6348,7 +6348,7 @@
       <filename>constants.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>F595D17B</checksum>
+      <checksum>CAB8C33B</checksum>
     </file>
     <file>
       <filename>apply_upgrade_test.rb</filename>

measures/ApplyUpgrade/resources/constants.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Constants
+module Constants
   def self.NumApplyUpgradeOptions
     return 25
   end

measures/QOIReport/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>qoi_report</name>
   <uid>be0bfc7f-25c6-435a-9acd-2f5fa8ac817d</uid>
-  <version_id>7f664618-267c-40c9-9245-03246f5e633c</version_id>
-  <version_modified>2023-11-28T23:34:12Z</version_modified>
+  <version_id>fd54daae-4705-4433-8b33-fb31dc6f9f8a</version_id>
+  <version_modified>2024-07-11T16:34:38Z</version_modified>
   <xml_checksum>15BF4E57</xml_checksum>
   <class_name>QOIReport</class_name>
   <display_name>QOI Report</display_name>
@@ -51,7 +51,7 @@
       <filename>constants.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>4A01E6CA</checksum>
+      <checksum>6AA4EA36</checksum>
     </file>
     <file>
       <filename>qoi_report_test.rb</filename>

measures/QOIReport/resources/constants.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Constants
+module Constants
   def self.SeasonHeating
     return 'Heating'
   end