diff --git a/docs/read_the_docs/source/workflow_inputs/characteristics.rst b/docs/read_the_docs/source/workflow_inputs/characteristics.rst index 5ca53f16ee..81845d98f0 100644 --- a/docs/read_the_docs/source/workflow_inputs/characteristics.rst +++ b/docs/read_the_docs/source/workflow_inputs/characteristics.rst @@ -206,7 +206,7 @@ Arguments - - Choice - auto, suburban, urban, rural - - The type of site. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. + - The type of site. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. * - ``site_iecc_zone`` - false - @@ -469,31 +469,31 @@ Arguments - # - Integer - auto - - The quantity of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The quantity of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``bathroom_fans_flow_rate`` - false - CFM - Double - auto - - The flow rate of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The flow rate of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``bathroom_fans_hours_in_operation`` - false - hrs/day - Double - auto - - The hours in operation of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The hours in operation of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``bathroom_fans_power`` - false - W - Double - auto - - The fan power of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The fan power of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``bathroom_fans_start_hour`` - false - hr - Integer - auto - - The start hour of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The start hour of the bathroom fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. Options ******* @@ -727,31 +727,31 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, crawlspace, crawlspace - vented, crawlspace - unvented, crawlspace - conditioned, attic, attic - vented, attic - unvented, garage, outside - - The space type for the lithium ion battery location. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. + - The space type for the lithium ion battery location. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. * - ``battery_power`` - false - W - Double - auto - - The rated power output of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. + - The rated power output of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. * - ``battery_capacity`` - false - kWh - Double - auto - - The nominal capacity of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. + - The nominal capacity of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. * - ``battery_usable_capacity`` - false - kWh - Double - auto - - The usable capacity of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. + - The usable capacity of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. * - ``battery_round_trip_efficiency`` - false - Frac - Double - auto - - The round trip efficiency of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. + - The round trip efficiency of the lithium ion battery. If not provided, the OS-HPXML default (see `HPXML Batteries `_) is used. Options ******* @@ -868,7 +868,7 @@ Arguments - # - Integer - auto - - The number of bathrooms in the unit. If not provided, the OS-HPXML default (see `HPXML Building Construction `_) is used. + - The number of bathrooms in the unit. If not provided, the OS-HPXML default (see `HPXML Building Construction `_) is used. Options ******* @@ -1097,25 +1097,25 @@ Arguments - W - Double - auto - - The label average energy use of the ceiling fan(s). If neither Efficiency nor Label Energy Use provided, the OS-HPXML default (see `HPXML Ceiling Fans `_) is used. + - The label average energy use of the ceiling fan(s). If neither Efficiency nor Label Energy Use provided, the OS-HPXML default (see `HPXML Ceiling Fans `_) is used. * - ``ceiling_fan_efficiency`` - false - CFM/W - Double - auto - - The efficiency rating of the ceiling fan(s) at medium speed. Only used if Label Energy Use not provided. If neither Efficiency nor Label Energy Use provided, the OS-HPXML default (see `HPXML Ceiling Fans `_) is used. + - The efficiency rating of the ceiling fan(s) at medium speed. Only used if Label Energy Use not provided. If neither Efficiency nor Label Energy Use provided, the OS-HPXML default (see `HPXML Ceiling Fans `_) is used. * - ``ceiling_fan_quantity`` - false - # - Integer - auto - - Total number of ceiling fans. If not provided, the OS-HPXML default (see `HPXML Ceiling Fans `_) is used. + - Total number of ceiling fans. If not provided, the OS-HPXML default (see `HPXML Ceiling Fans `_) is used. * - ``ceiling_fan_cooling_setpoint_temp_offset`` - false - 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 `_) is used. + - 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 `_) is used. Options ******* @@ -4797,7 +4797,7 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The space type for the clothes dryer location. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. + - The space type for the clothes dryer location. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. * - ``clothes_dryer_fuel_type`` - true - @@ -4815,13 +4815,13 @@ Arguments - lb/kWh - Double - auto - - The efficiency of the clothes dryer. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. + - The efficiency of the clothes dryer. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. * - ``clothes_dryer_vented_flow_rate`` - false - CFM - Double - auto - - The exhaust flow rate of the vented clothes dryer. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. + - The exhaust flow rate of the vented clothes dryer. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. Options ******* @@ -4928,7 +4928,7 @@ Arguments - - Double - auto - - Multiplier on the clothes dryer energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. + - Multiplier on the clothes dryer energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Clothes Dryer `_) is used. Options ******* @@ -5023,7 +5023,7 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The space type for the clothes washer location. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - The space type for the clothes washer location. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. * - ``clothes_washer_efficiency_type`` - true - @@ -5035,43 +5035,43 @@ Arguments - ft^3/kWh-cyc - Double - auto - - The efficiency of the clothes washer. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - The efficiency of the clothes washer. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. * - ``clothes_washer_rated_annual_kwh`` - false - kWh/yr - Double - auto - - The annual energy consumed by the clothes washer, as rated, obtained from the EnergyGuide label. This includes both the appliance electricity consumption and the energy required for water heating. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - The annual energy consumed by the clothes washer, as rated, obtained from the EnergyGuide label. This includes both the appliance electricity consumption and the energy required for water heating. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. * - ``clothes_washer_label_electric_rate`` - false - $/kWh - Double - auto - - The annual energy consumed by the clothes washer, as rated, obtained from the EnergyGuide label. This includes both the appliance electricity consumption and the energy required for water heating. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - The annual energy consumed by the clothes washer, as rated, obtained from the EnergyGuide label. This includes both the appliance electricity consumption and the energy required for water heating. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. * - ``clothes_washer_label_gas_rate`` - false - $/therm - Double - auto - - The annual energy consumed by the clothes washer, as rated, obtained from the EnergyGuide label. This includes both the appliance electricity consumption and the energy required for water heating. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - The annual energy consumed by the clothes washer, as rated, obtained from the EnergyGuide label. This includes both the appliance electricity consumption and the energy required for water heating. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. * - ``clothes_washer_label_annual_gas_cost`` - false - $ - Double - auto - - The annual cost of using the system under test conditions. Input is obtained from the EnergyGuide label. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - The annual cost of using the system under test conditions. Input is obtained from the EnergyGuide label. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. * - ``clothes_washer_label_usage`` - false - cyc/wk - Double - auto - - The clothes washer loads per week. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - The clothes washer loads per week. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. * - ``clothes_washer_capacity`` - false - ft^3 - Double - auto - - Volume of the washer drum. Obtained from the EnergyStar website or the manufacturer's literature. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - Volume of the washer drum. Obtained from the EnergyStar website or the manufacturer's literature. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. Options ******* @@ -5296,7 +5296,7 @@ Arguments - - Double - auto - - Multiplier on the clothes washer energy and hot water usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. + - Multiplier on the clothes washer energy and hot water usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Clothes Washer `_) is used. Options ******* @@ -5417,7 +5417,7 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The space type for the cooking range/oven location. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. + - The space type for the cooking range/oven location. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. * - ``cooking_range_oven_fuel_type`` - true - @@ -5429,13 +5429,13 @@ Arguments - - Boolean - auto, true, false - - Whether the cooking range is induction. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. + - Whether the cooking range is induction. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. * - ``cooking_range_oven_is_convection`` - false - - Boolean - auto, true, false - - Whether the oven is convection. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. + - Whether the oven is convection. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. Options ******* @@ -5543,7 +5543,7 @@ Arguments - - Double - auto - - Multiplier on the cooking range/oven energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. + - Multiplier on the cooking range/oven energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Cooking Range/Oven `_) is used. Options ******* @@ -5616,7 +5616,7 @@ Arguments - - String - auto - - Enter a date range like 'Jun 1 - Oct 31'. If not provided, the OS-HPXML default (see `HPXML HVAC Control `_) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols. + - Enter a date range like 'Jun 1 - Oct 31'. If not provided, the OS-HPXML default (see `HPXML HVAC Control `_) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols. * - ``hvac_control_cooling_weekday_setpoint_temp`` - true - deg-F @@ -6356,7 +6356,7 @@ Arguments - - Boolean - auto, true, false - - Whether to use daylight saving. If not provided, the OS-HPXML default (see `HPXML Building Site `_) is used. + - Whether to use daylight saving. If not provided, the OS-HPXML default (see `HPXML Building Site `_) is used. * - ``site_zip_code`` - false - @@ -6368,7 +6368,7 @@ Arguments - hr - Double - auto - - Time zone UTC offset of the home address. Must be between -12 and 14. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. + - Time zone UTC offset of the home address. Must be between -12 and 14. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. * - ``weather_station_epw_filepath`` - false - @@ -34619,7 +34619,7 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The space type for the dishwasher location. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - The space type for the dishwasher location. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. * - ``dishwasher_efficiency_type`` - true - @@ -34631,37 +34631,37 @@ Arguments - RatedAnnualkWh or EnergyFactor - Double - auto - - The efficiency of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - The efficiency of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. * - ``dishwasher_label_electric_rate`` - false - $/kWh - Double - auto - - The label electric rate of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - The label electric rate of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. * - ``dishwasher_label_gas_rate`` - false - $/therm - Double - auto - - The label gas rate of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - The label gas rate of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. * - ``dishwasher_label_annual_gas_cost`` - false - $ - Double - auto - - The label annual gas cost of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - The label annual gas cost of the dishwasher. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. * - ``dishwasher_label_usage`` - false - cyc/wk - Double - auto - - The dishwasher loads per week. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - The dishwasher loads per week. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. * - ``dishwasher_place_setting_capacity`` - false - # - Integer - auto - - The number of place settings for the unit. Data obtained from manufacturer's literature. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - The number of place settings for the unit. Data obtained from manufacturer's literature. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. Options ******* @@ -34775,7 +34775,7 @@ Arguments - - Double - auto - - Multiplier on the dishwasher energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. + - Multiplier on the dishwasher energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Dishwasher `_) is used. Options ******* @@ -34990,7 +34990,7 @@ Arguments - frac - Double - auto - - The fraction of supply ducts that are rectangular (as opposed to round); this affects the duct effective R-value used for modeling. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The fraction of supply ducts that are rectangular (as opposed to round); this affects the duct effective R-value used for modeling. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. * - ``ducts_return_leakage_to_outside_value`` - true - @@ -35014,7 +35014,7 @@ Arguments - frac - Double - auto - - The fraction of return ducts that are rectangular (as opposed to round); this affects the duct effective R-value used for modeling. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The fraction of return ducts that are rectangular (as opposed to round); this affects the duct effective R-value used for modeling. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. Options ******* @@ -35238,43 +35238,43 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, crawlspace, crawlspace - vented, crawlspace - unvented, crawlspace - conditioned, attic, attic - vented, attic - unvented, garage, exterior wall, under slab, roof deck, outside, other housing unit, other heated space, other multifamily buffer space, other non-freezing space, manufactured home belly - - The location of the supply ducts. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The location of the supply ducts. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. * - ``ducts_supply_surface_area`` - false - ft^2 - Double - auto - - The supply ducts surface area in the given location. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The supply ducts surface area in the given location. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. * - ``ducts_supply_surface_area_fraction`` - false - frac - Double - auto - - The fraction of supply ducts surface area in the given location. Only used if Surface Area is not provided. If the fraction is less than 1, the remaining duct area is assumed to be in conditioned space. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The fraction of supply ducts surface area in the given location. Only used if Surface Area is not provided. If the fraction is less than 1, the remaining duct area is assumed to be in conditioned space. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. * - ``ducts_return_location`` - false - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, crawlspace, crawlspace - vented, crawlspace - unvented, crawlspace - conditioned, attic, attic - vented, attic - unvented, garage, exterior wall, under slab, roof deck, outside, other housing unit, other heated space, other multifamily buffer space, other non-freezing space, manufactured home belly - - The location of the return ducts. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The location of the return ducts. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. * - ``ducts_return_surface_area`` - false - ft^2 - Double - auto - - The return ducts surface area in the given location. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The return ducts surface area in the given location. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. * - ``ducts_return_surface_area_fraction`` - false - frac - Double - auto - - The fraction of return ducts surface area in the given location. Only used if Surface Area is not provided. If the fraction is less than 1, the remaining duct area is assumed to be in conditioned space. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The fraction of return ducts surface area in the given location. Only used if Surface Area is not provided. If the fraction is less than 1, the remaining duct area is assumed to be in conditioned space. If neither Surface Area nor Area Fraction provided, the OS-HPXML default (see `Air Distribution `_) is used. * - ``ducts_number_of_return_registers`` - false - # - Integer - auto - - The number of return registers of the ducts. Only used to calculate default return duct surface area. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. + - The number of return registers of the ducts. Only used to calculate default return duct surface area. If not provided, the OS-HPXML default (see `Air Distribution `_) is used. Options ******* @@ -35464,13 +35464,13 @@ Arguments - kWh/yr - Double - auto - - The annual energy consumption of the electric vehicle plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - The annual energy consumption of the electric vehicle plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_vehicle_usage_multiplier`` - false - - Double - auto - - Multiplier on the electric vehicle energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - Multiplier on the electric vehicle energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_vehicle_2_usage_multiplier`` - true - @@ -37459,13 +37459,13 @@ Arguments - - Choice - auto, aluminum siding, asbestos siding, brick veneer, composite shingle siding, fiber cement siding, masonite siding, none, stucco, synthetic stucco, vinyl siding, wood siding - - The siding type of the walls. Also applies to rim joists. If not provided, the OS-HPXML default (see `HPXML Walls `_) is used. + - The siding type of the walls. Also applies to rim joists. If not provided, the OS-HPXML default (see `HPXML Walls `_) is used. * - ``wall_color`` - false - - Choice - auto, dark, light, medium, medium dark, reflective - - The color of the walls. Also applies to rim joists. If not provided, the OS-HPXML default (see `HPXML Walls `_) is used. + - The color of the walls. Also applies to rim joists. If not provided, the OS-HPXML default (see `HPXML Walls `_) is used. * - ``exterior_finish_r`` - true - h-ft^2-R/Btu @@ -37647,7 +37647,7 @@ Arguments - - Choice - auto, clay, dry, clay, mixed, clay, wet, gravel, dry, gravel, mixed, gravel, wet, loam, dry, loam, mixed, loam, wet, sand, dry, sand, mixed, sand, wet, silt, dry, silt, mixed, silt, wet, unknown, dry, unknown, mixed, unknown, wet - - Type of soil and moisture. This is used to inform ground conductivity and diffusivity. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. + - Type of soil and moisture. This is used to inform ground conductivity and diffusivity. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. * - ``site_ground_conductivity`` - false - Btu/hr-ft-F @@ -37860,19 +37860,19 @@ Arguments - - Choice - auto, single stage, two stage, variable speed - - The compressor type of the cooling system. Only applies to central air conditioner and mini-split. If not provided, the OS-HPXML default (see `Central Air Conditioner `_, `Mini-Split Air Conditioner `_) is used. + - The compressor type of the cooling system. Only applies to central air conditioner and mini-split. If not provided, the OS-HPXML default (see `Central Air Conditioner `_, `Mini-Split Air Conditioner `_) is used. * - ``cooling_system_cooling_sensible_heat_fraction`` - false - Frac - Double - auto - - The sensible heat fraction of the cooling system. Ignored for evaporative cooler. If not provided, the OS-HPXML default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Mini-Split Air Conditioner `_) is used. + - The sensible heat fraction of the cooling system. Ignored for evaporative cooler. If not provided, the OS-HPXML default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Mini-Split Air Conditioner `_) is used. * - ``cooling_system_cooling_capacity`` - false - Btu/hr - Double - - - The output cooling capacity of the cooling system. If not provided, the OS-HPXML autosized default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Evaporative Cooler `_, `Mini-Split Air Conditioner `_) is used. + - The output cooling capacity of the cooling system. If not provided, the OS-HPXML autosized default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Evaporative Cooler `_, `Mini-Split Air Conditioner `_) is used. * - ``cooling_system_cooling_autosizing_limit`` - false - Btu/hr @@ -37890,7 +37890,7 @@ Arguments - W - Double - auto - - Cooling system crankcase heater power consumption in Watts. Applies only to central air conditioner, room air conditioner, packaged terminal air conditioner and mini-split. If not provided, the OS-HPXML default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Mini-Split Air Conditioner `_) is used. + - Cooling system crankcase heater power consumption in Watts. Applies only to central air conditioner, room air conditioner, packaged terminal air conditioner and mini-split. If not provided, the OS-HPXML default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Mini-Split Air Conditioner `_) is used. * - ``cooling_system_integrated_heating_system_fuel`` - false - @@ -37908,7 +37908,7 @@ Arguments - Btu/hr - Double - - - The output heating capacity of the heating system integrated into cooling system. If not provided, the OS-HPXML autosized default (see `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_) is used. Only used for room air conditioner and packaged terminal air conditioner. + - The output heating capacity of the heating system integrated into cooling system. If not provided, the OS-HPXML autosized default (see `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_) is used. Only used for room air conditioner and packaged terminal air conditioner. * - ``cooling_system_integrated_heating_system_fraction_heat_load_served`` - false - Frac @@ -38335,7 +38335,7 @@ Arguments - W/CFM - Double - auto - - The blower fan efficiency at maximum fan speed. Applies only to split (not packaged) systems (i.e., applies to ducted systems as well as ductless mini-split systems). If not provided, the OS-HPXML default (see `HPXML Heating Systems `_, `HPXML Cooling Systems `_, `HPXML Heat Pumps `_) is used. + - The blower fan efficiency at maximum fan speed. Applies only to split (not packaged) systems (i.e., applies to ducted systems as well as ductless mini-split systems). If not provided, the OS-HPXML default (see `HPXML Heating Systems `_, `HPXML Cooling Systems `_, `HPXML Heat Pumps `_) is used. Options ******* @@ -38639,7 +38639,7 @@ Arguments - Btu/hr - Double - - - The output heating capacity of the heating system. If not provided, the OS-HPXML autosized default (see `HPXML Heating Systems `_) is used. + - The output heating capacity of the heating system. If not provided, the OS-HPXML autosized default (see `HPXML Heating Systems `_) is used. * - ``heating_system_heating_autosizing_limit`` - false - Btu/hr @@ -38693,19 +38693,19 @@ Arguments - - Choice - auto, single stage, two stage, variable speed - - The compressor type of the heat pump. Only applies to air-to-air and mini-split. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_) is used. + - The compressor type of the heat pump. Only applies to air-to-air and mini-split. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_) is used. * - ``heat_pump_cooling_sensible_heat_fraction`` - false - Frac - Double - auto - - The sensible heat fraction of the heat pump. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. + - The sensible heat fraction of the heat pump. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. * - ``heat_pump_heating_capacity`` - false - Btu/hr - Double - - - The output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. + - The output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. * - ``heat_pump_heating_autosizing_limit`` - false - Btu/hr @@ -38717,7 +38717,7 @@ Arguments - Frac - Double - auto - - 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 `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_) is used. + - 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 `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_) is used. * - ``heat_pump_heating_capacity_retention_temp`` - false - F @@ -38729,7 +38729,7 @@ Arguments - Btu/hr - Double - - - The output cooling capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. + - The output cooling capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. * - ``heat_pump_cooling_autosizing_limit`` - false - Btu/hr @@ -38753,7 +38753,7 @@ Arguments - 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 `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_) is used. + - 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 `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_) is used. * - ``heat_pump_backup_type`` - true - @@ -38783,25 +38783,25 @@ Arguments - Btu/hr - Double - - - The backup output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Backup `_) is used. Only applies if Backup Type is 'integrated'. + - The backup output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Backup `_) is used. Only applies if Backup Type is 'integrated'. * - ``heat_pump_backup_heating_lockout_temp`` - false - 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 `_) is used. + - 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 `_) is used. * - ``heat_pump_sizing_methodology`` - false - - Choice - auto, ACCA, HERS, MaxLoad - - The auto-sizing methodology to use when the heat pump capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. + - The auto-sizing methodology to use when the heat pump capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. * - ``heat_pump_backup_sizing_methodology`` - false - - Choice - auto, emergency, supplemental - - The auto-sizing methodology to use when the heat pump backup capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. + - The auto-sizing methodology to use when the heat pump backup capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. * - ``heat_pump_is_ducted`` - false - @@ -38813,67 +38813,67 @@ Arguments - W - Double - auto - - Heat Pump crankcase heater power consumption in Watts. Applies only to air-to-air, mini-split, packaged terminal heat pump and room air conditioner with reverse cycle. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_) is used. + - Heat Pump crankcase heater power consumption in Watts. Applies only to air-to-air, mini-split, packaged terminal heat pump and room air conditioner with reverse cycle. If not provided, the OS-HPXML default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_) is used. * - ``geothermal_loop_configuration`` - false - - Choice - auto, none, vertical - - Configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `Ground-to-Air Heat Pump `_) is used. + - Configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `Ground-to-Air Heat Pump `_) is used. * - ``geothermal_loop_borefield_configuration`` - false - - Choice - auto, Rectangle, Open Rectangle, C, L, U, Lopsided U - - Borefield configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Borefield configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_loop_flow`` - false - gpm - Double - - - Water flow rate through the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. + - Water flow rate through the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_count`` - false - # - Integer - - - Number of boreholes. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. + - Number of boreholes. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_length`` - false - ft - Double - - - Average length of each borehole (vertical). Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. + - Average length of each borehole (vertical). Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_spacing`` - false - ft - Double - auto - - Distance between bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Distance between bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_diameter`` - false - in - Double - auto - - Diameter of bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Diameter of bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_grout_type`` - false - - Choice - auto, standard, thermally enhanced - - Grout type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Grout type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_pipe_type`` - false - - Choice - auto, standard, thermally enhanced - - Pipe type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Pipe type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_pipe_diameter`` - false - in - Choice - auto, 3/4" pipe, 1" pipe, 1-1/4" pipe - - Pipe diameter of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Pipe diameter of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``heating_system_has_flue_or_chimney`` - true - @@ -40090,7 +40090,7 @@ Arguments - Btu/hr - Double - - - The output heating capacity of the second heating system. If not provided, the OS-HPXML autosized default (see `HPXML Heating Systems `_) is used. + - The output heating capacity of the second heating system. If not provided, the OS-HPXML autosized default (see `HPXML Heating Systems `_) is used. * - ``heating_system_2_heating_autosizing_limit`` - false - Btu/hr @@ -40475,7 +40475,7 @@ Arguments - Btu/hr - Double - - - The output heating capacity of the heating system. If not provided, the OS-HPXML autosized default (see `HPXML Heating Systems `_) is used. + - The output heating capacity of the heating system. If not provided, the OS-HPXML autosized default (see `HPXML Heating Systems `_) is used. * - ``heating_system_heating_autosizing_limit`` - false - Btu/hr @@ -40511,7 +40511,7 @@ Arguments - Btu/hr - Double - - - The output cooling capacity of the cooling system. If not provided, the OS-HPXML autosized default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Evaporative Cooler `_, `Mini-Split Air Conditioner `_) is used. + - The output cooling capacity of the cooling system. If not provided, the OS-HPXML autosized default (see `Central Air Conditioner `_, `Room Air Conditioner `_, `Packaged Terminal Air Conditioner `_, `Evaporative Cooler `_, `Mini-Split Air Conditioner `_) is used. * - ``cooling_system_cooling_autosizing_limit`` - false - Btu/hr @@ -40559,7 +40559,7 @@ Arguments - Btu/hr - Double - - - The output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. + - The output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. * - ``heat_pump_heating_autosizing_limit`` - false - Btu/hr @@ -40571,7 +40571,7 @@ Arguments - Btu/hr - Double - - - The output cooling capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. + - The output cooling capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Air-to-Air Heat Pump `_, `Mini-Split Heat Pump `_, `Packaged Terminal Heat Pump `_, `Room Air Conditioner w/ Reverse Cycle `_, `Ground-to-Air Heat Pump `_) is used. * - ``heat_pump_cooling_autosizing_limit`` - false - Btu/hr @@ -40619,79 +40619,79 @@ Arguments - Btu/hr - Double - - - The backup output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Backup `_) is used. Only applies if Backup Type is 'integrated'. + - The backup output heating capacity of the heat pump. If not provided, the OS-HPXML autosized default (see `Backup `_) is used. Only applies if Backup Type is 'integrated'. * - ``heat_pump_sizing_methodology`` - false - - Choice - auto, ACCA, HERS, MaxLoad - - The auto-sizing methodology to use when the heat pump capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. + - The auto-sizing methodology to use when the heat pump capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. * - ``heat_pump_backup_sizing_methodology`` - false - - Choice - auto, emergency, supplemental - - The auto-sizing methodology to use when the heat pump backup capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. + - The auto-sizing methodology to use when the heat pump backup capacity is not provided. If not provided, the OS-HPXML default (see `HPXML HVAC Sizing Control `_) is used. * - ``geothermal_loop_configuration`` - false - - Choice - auto, none, vertical - - Configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `Ground-to-Air Heat Pump `_) is used. + - Configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `Ground-to-Air Heat Pump `_) is used. * - ``geothermal_loop_borefield_configuration`` - false - - Choice - auto, Rectangle, Open Rectangle, C, L, U, Lopsided U - - Borefield configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Borefield configuration of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_loop_flow`` - false - gpm - Double - - - Water flow rate through the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. + - Water flow rate through the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_count`` - false - # - Integer - - - Number of boreholes. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. + - Number of boreholes. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_length`` - false - ft - Double - - - Average length of each borehole (vertical). Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. + - Average length of each borehole (vertical). Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML autosized default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_spacing`` - false - ft - Double - auto - - Distance between bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Distance between bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_boreholes_diameter`` - false - in - Double - auto - - Diameter of bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Diameter of bores. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_grout_type`` - false - - Choice - auto, standard, thermally enhanced - - Grout type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Grout type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_pipe_type`` - false - - Choice - auto, standard, thermally enhanced - - Pipe type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Pipe type of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``geothermal_loop_pipe_diameter`` - false - in - Choice - auto, 3/4" pipe, 1" pipe, 1-1/4" pipe - - Pipe diameter of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. + - Pipe diameter of the geothermal loop. Only applies to ground-to-air heat pump type. If not provided, the OS-HPXML default (see `HPXML Geothermal Loops `_) is used. * - ``heating_system_has_flue_or_chimney`` - true - @@ -41704,7 +41704,7 @@ Arguments - - String - auto - - Enter a date range like 'Nov 1 - Jun 30'. If not provided, the OS-HPXML default (see `HPXML HVAC Control `_) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols. + - Enter a date range like 'Nov 1 - Jun 30'. If not provided, the OS-HPXML default (see `HPXML HVAC Control `_) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols. * - ``hvac_control_heating_weekday_setpoint_temp`` - true - deg-F @@ -42290,13 +42290,13 @@ Arguments - kWh/day - Double - auto - - The daily energy consumption for holiday lighting (exterior). If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. + - The daily energy consumption for holiday lighting (exterior). If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. * - ``holiday_lighting_period`` - false - - String - auto - - Enter a date range like 'Nov 25 - Jan 5'. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. + - Enter a date range like 'Nov 25 - Jan 5'. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. Options ******* @@ -42365,7 +42365,7 @@ Arguments - ft - Double - auto - - If the distribution system is Standard, the length of the piping. If not provided, the OS-HPXML default (see `Standard `_) is used. + - If the distribution system is Standard, the length of the piping. If not provided, the OS-HPXML default (see `Standard `_) is used. * - ``hot_water_distribution_recirc_control_type`` - false - @@ -42377,25 +42377,25 @@ Arguments - ft - Double - auto - - If the distribution system is Recirculation, the length of the recirculation piping. If not provided, the OS-HPXML default (see `Recirculation (In-Unit) `_) is used. + - If the distribution system is Recirculation, the length of the recirculation piping. If not provided, the OS-HPXML default (see `Recirculation (In-Unit) `_) is used. * - ``hot_water_distribution_recirc_branch_piping_length`` - false - ft - Double - auto - - If the distribution system is Recirculation, the length of the recirculation branch piping. If not provided, the OS-HPXML default (see `Recirculation (In-Unit) `_) is used. + - If the distribution system is Recirculation, the length of the recirculation branch piping. If not provided, the OS-HPXML default (see `Recirculation (In-Unit) `_) is used. * - ``hot_water_distribution_recirc_pump_power`` - false - W - Double - auto - - If the distribution system is Recirculation, the recirculation pump power. If not provided, the OS-HPXML default (see `Recirculation (In-Unit) `_) is used. + - If the distribution system is Recirculation, the recirculation pump power. If not provided, the OS-HPXML default (see `Recirculation (In-Unit) `_) is used. * - ``hot_water_distribution_pipe_r`` - false - h-ft^2-R/Btu - Double - auto - - Nominal R-value of the pipe insulation. If not provided, the OS-HPXML default (see `HPXML Hot Water Distribution `_) is used. + - Nominal R-value of the pipe insulation. If not provided, the OS-HPXML default (see `HPXML Hot Water Distribution `_) is used. * - ``dwhr_facilities_connected`` - true - @@ -42508,7 +42508,7 @@ Arguments - - Double - auto - - Multiplier on the hot water usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Water Fixtures `_) is used. + - Multiplier on the hot water usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Water Fixtures `_) is used. Options ******* @@ -42965,7 +42965,7 @@ 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 `_) is used. + - Presence of nearby buildings, trees, obstructions for infiltration model. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. * - ``air_leakage_leakiness_description`` - false - @@ -43372,13 +43372,13 @@ Arguments - - Choice - auto, solid concrete, concrete block, concrete block foam core, concrete block perlite core, concrete block vermiculite core, concrete block solid core, double brick, wood - - The material type of the foundation wall. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. + - The material type of the foundation wall. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. * - ``foundation_wall_thickness`` - false - in - Double - auto - - The thickness of the foundation wall. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. + - The thickness of the foundation wall. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. * - ``foundation_wall_insulation_r`` - true - h-ft^2-R/Btu @@ -43396,13 +43396,13 @@ Arguments - ft - Double - auto - - The distance from the top of the foundation wall to the top of the foundation wall insulation. Only applies to basements/crawlspaces. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. + - The distance from the top of the foundation wall to the top of the foundation wall insulation. Only applies to basements/crawlspaces. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. * - ``foundation_wall_insulation_distance_to_bottom`` - false - ft - Double - auto - - The distance from the top of the foundation wall to the bottom of the foundation wall insulation. Only applies to basements/crawlspaces. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. + - The distance from the top of the foundation wall to the bottom of the foundation wall insulation. Only applies to basements/crawlspaces. If not provided, the OS-HPXML default (see `HPXML Foundation Walls `_) is used. * - ``foundation_wall_assembly_r`` - false - h-ft^2-R/Btu @@ -43762,19 +43762,19 @@ Arguments - in - Double - auto - - The thickness of the slab. Zero can be entered if there is a dirt floor instead of a slab. If not provided, the OS-HPXML default (see `HPXML Slabs `_) is used. + - The thickness of the slab. Zero can be entered if there is a dirt floor instead of a slab. If not provided, the OS-HPXML default (see `HPXML Slabs `_) is used. * - ``slab_carpet_fraction`` - false - Frac - Double - auto - - Fraction of the slab floor area that is carpeted. If not provided, the OS-HPXML default (see `HPXML Slabs `_) is used. + - Fraction of the slab floor area that is carpeted. If not provided, the OS-HPXML default (see `HPXML Slabs `_) is used. * - ``slab_carpet_r`` - false - h-ft^2-R/Btu - Double - auto - - R-value of the slab carpet. If not provided, the OS-HPXML default (see `HPXML Slabs `_) is used. + - R-value of the slab carpet. If not provided, the OS-HPXML default (see `HPXML Slabs `_) is used. Options ******* @@ -44072,19 +44072,19 @@ Arguments - - Choice - auto, light curtains, light shades, light blinds, medium curtains, medium shades, medium blinds, dark curtains, dark shades, dark blinds, none - - Type of window interior shading. Summer/winter shading coefficients can be provided below instead. If neither is provided, the OS-HPXML default (see `HPXML Interior Shading `_) is used. + - Type of window interior shading. Summer/winter shading coefficients can be provided below instead. If neither is provided, the OS-HPXML default (see `HPXML Interior Shading `_) is used. * - ``window_interior_shading_winter`` - false - Frac - Double - auto - - Interior shading coefficient for the winter season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Interior Shading `_) is used. + - Interior shading coefficient for the winter season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Interior Shading `_) is used. * - ``window_interior_shading_summer`` - false - Frac - Double - auto - - Interior shading coefficient for the summer season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Interior Shading `_) is used. + - Interior shading coefficient for the summer season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Interior Shading `_) is used. Options ******* @@ -44313,7 +44313,7 @@ Arguments - - Double - auto - - Multiplier on the lighting energy usage (interior) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. + - Multiplier on the lighting energy usage (interior) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. Options ******* @@ -44374,13 +44374,13 @@ Arguments - - Double - auto - - Multiplier on the lighting energy usage (exterior) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. + - Multiplier on the lighting energy usage (exterior) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. * - ``lighting_garage_usage_multiplier`` - false - - Double - auto - - Multiplier on the lighting energy usage (garage) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. + - Multiplier on the lighting energy usage (garage) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Lighting `_) is used. Options ******* @@ -44510,13 +44510,13 @@ Arguments - CFM - Double - auto - - The flow rate of the mechanical ventilation. If not provided, the OS-HPXML default (see `HPXML Mechanical Ventilation Fans `_) is used. + - The flow rate of the mechanical ventilation. If not provided, the OS-HPXML default (see `HPXML Mechanical Ventilation Fans `_) is used. * - ``mech_vent_hours_in_operation`` - false - hrs/day - Double - auto - - The hours in operation of the mechanical ventilation. If not provided, the OS-HPXML default (see `HPXML Mechanical Ventilation Fans `_) is used. + - The hours in operation of the mechanical ventilation. If not provided, the OS-HPXML default (see `HPXML Mechanical Ventilation Fans `_) is used. * - ``mech_vent_recovery_efficiency_type`` - true - @@ -44540,7 +44540,7 @@ Arguments - W - Double - auto - - The fan power of the mechanical ventilation. If not provided, the OS-HPXML default (see `HPXML Mechanical Ventilation Fans `_) is used. + - The fan power of the mechanical ventilation. If not provided, the OS-HPXML default (see `HPXML Mechanical Ventilation Fans `_) is used. * - ``mech_vent_num_units_served`` - true - # @@ -44642,13 +44642,13 @@ Arguments - CFM - Double - auto - - The flow rate of the whole house fan. If not provided, the OS-HPXML default (see `HPXML Whole House Fans `_) is used. + - The flow rate of the whole house fan. If not provided, the OS-HPXML default (see `HPXML Whole House Fans `_) is used. * - ``whole_house_fan_power`` - false - W - Double - auto - - The fan power of the whole house fan. If not provided, the OS-HPXML default (see `HPXML Whole House Fans `_) is used. + - The fan power of the whole house fan. If not provided, the OS-HPXML default (see `HPXML Whole House Fans `_) is used. Options ******* @@ -46692,19 +46692,19 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The space type for the extra refrigerator location. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. + - The space type for the extra refrigerator location. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. * - ``extra_refrigerator_rated_annual_kwh`` - false - kWh/yr - Double - auto - - The EnergyGuide rated annual energy consumption for an extra refrigerator. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. + - The EnergyGuide rated annual energy consumption for an extra refrigerator. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. * - ``extra_refrigerator_usage_multiplier`` - false - - Double - auto - - Multiplier on the extra refrigerator energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. + - Multiplier on the extra refrigerator energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. Options ******* @@ -46847,19 +46847,19 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The space type for the freezer location. If not provided, the OS-HPXML default (see `HPXML Freezers `_) is used. + - The space type for the freezer location. If not provided, the OS-HPXML default (see `HPXML Freezers `_) is used. * - ``freezer_rated_annual_kwh`` - false - kWh/yr - Double - auto - - The EnergyGuide rated annual energy consumption for a freezer. If not provided, the OS-HPXML default (see `HPXML Freezers `_) is used. + - The EnergyGuide rated annual energy consumption for a freezer. If not provided, the OS-HPXML default (see `HPXML Freezers `_) is used. * - ``freezer_usage_multiplier`` - false - - Double - auto - - Multiplier on the freezer energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Freezers `_) is used. + - Multiplier on the freezer energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Freezers `_) is used. Options ******* @@ -46948,25 +46948,25 @@ Arguments - therm/yr - Double - auto - - The annual energy consumption of the fuel loads fireplace. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. + - The annual energy consumption of the fuel loads fireplace. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. * - ``misc_fuel_loads_fireplace_frac_sensible`` - false - Frac - Double - auto - - Fraction of fireplace residual fuel loads' internal gains that are sensible. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. + - Fraction of fireplace residual fuel loads' internal gains that are sensible. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. * - ``misc_fuel_loads_fireplace_frac_latent`` - false - Frac - Double - auto - - Fraction of fireplace residual fuel loads' internal gains that are latent. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. + - Fraction of fireplace residual fuel loads' internal gains that are latent. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. * - ``misc_fuel_loads_fireplace_usage_multiplier`` - false - - Double - auto - - Multiplier on the fuel loads fireplace energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. + - Multiplier on the fuel loads fireplace energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. Options ******* @@ -47055,13 +47055,13 @@ Arguments - therm/yr - Double - auto - - The annual energy consumption of the fuel loads grill. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. + - The annual energy consumption of the fuel loads grill. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. * - ``misc_fuel_loads_grill_usage_multiplier`` - false - - Double - auto - - Multiplier on the fuel loads grill energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. + - Multiplier on the fuel loads grill energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. Options ******* @@ -47144,13 +47144,13 @@ Arguments - therm/yr - Double - auto - - The annual energy consumption of the fuel loads lighting. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_)is used. + - The annual energy consumption of the fuel loads lighting. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_)is used. * - ``misc_fuel_loads_lighting_usage_multiplier`` - false - - Double - auto - - Multiplier on the fuel loads lighting energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. + - Multiplier on the fuel loads lighting energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Fuel Loads `_) is used. Options ******* @@ -47271,13 +47271,13 @@ Arguments - kWh/yr - Double - auto - - The annual energy consumption of the permanent spa pump. If not provided, the OS-HPXML default (see `Permanent Spa Pump `_) is used. + - The annual energy consumption of the permanent spa pump. If not provided, the OS-HPXML default (see `Permanent Spa Pump `_) is used. * - ``permanent_spa_pump_usage_multiplier`` - false - - Double - auto - - Multiplier on the permanent spa pump energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Permanent Spa Pump `_) is used. + - Multiplier on the permanent spa pump energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Permanent Spa Pump `_) is used. * - ``permanent_spa_heater_type`` - true - @@ -47289,19 +47289,19 @@ Arguments - kWh/yr - Double - auto - - The annual energy consumption of the electric resistance permanent spa heater. If not provided, the OS-HPXML default (see `Permanent Spa Heater `_) is used. + - The annual energy consumption of the electric resistance permanent spa heater. If not provided, the OS-HPXML default (see `Permanent Spa Heater `_) is used. * - ``permanent_spa_heater_annual_therm`` - false - therm/yr - Double - auto - - The annual energy consumption of the gas fired permanent spa heater. If not provided, the OS-HPXML default (see `Permanent Spa Heater `_) is used. + - The annual energy consumption of the gas fired permanent spa heater. If not provided, the OS-HPXML default (see `Permanent Spa Heater `_) is used. * - ``permanent_spa_heater_usage_multiplier`` - false - - Double - auto - - Multiplier on the permanent spa heater energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Permanent Spa Heater `_) is used. + - Multiplier on the permanent spa heater energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Permanent Spa Heater `_) is used. Options ******* @@ -47507,19 +47507,19 @@ Arguments - kWh/yr - Double - auto - - The annual energy consumption of the electric resistance pool heater. If not provided, the OS-HPXML default (see `Pool Heater `_) is used. + - The annual energy consumption of the electric resistance pool heater. If not provided, the OS-HPXML default (see `Pool Heater `_) is used. * - ``pool_heater_annual_therm`` - false - therm/yr - Double - auto - - The annual energy consumption of the gas fired pool heater. If not provided, the OS-HPXML default (see `Pool Heater `_) is used. + - The annual energy consumption of the gas fired pool heater. If not provided, the OS-HPXML default (see `Pool Heater `_) is used. * - ``pool_heater_usage_multiplier`` - false - - Double - auto - - Multiplier on the pool heater energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Pool Heater `_) is used. + - Multiplier on the pool heater energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Pool Heater `_) is used. Options ******* @@ -47602,13 +47602,13 @@ Arguments - kWh/yr - Double - auto - - The annual energy consumption of the pool pump. If not provided, the OS-HPXML default (see `Pool Pump `_) is used. + - The annual energy consumption of the pool pump. If not provided, the OS-HPXML default (see `Pool Pump `_) is used. * - ``pool_pump_usage_multiplier`` - false - - Double - auto - - Multiplier on the pool pump energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Pool Pump `_) is used. + - Multiplier on the pool pump energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `Pool Pump `_) is used. Options ******* @@ -47679,13 +47679,13 @@ Arguments - kWh/yr - Double - auto - - The annual energy consumption of the well pump plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - The annual energy consumption of the well pump plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_well_pump_usage_multiplier`` - false - - Double - auto - - Multiplier on the well pump energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - Multiplier on the well pump energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_well_pump_2_usage_multiplier`` - true - @@ -47762,7 +47762,7 @@ Arguments - Frac - Double - auto - - Fraction of windows that are operable. If not provided, the OS-HPXML default (see `HPXML Windows `_) is used. + - Fraction of windows that are operable. If not provided, the OS-HPXML default (see `HPXML Windows `_) is used. Options ******* @@ -47847,25 +47847,25 @@ Arguments - ft - Double - auto - - The height of the neighboring building to the front. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. + - The height of the neighboring building to the front. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. * - ``neighbor_back_height`` - false - ft - Double - auto - - The height of the neighboring building to the back. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. + - The height of the neighboring building to the back. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. * - ``neighbor_left_height`` - false - ft - Double - auto - - The height of the neighboring building to the left. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. + - The height of the neighboring building to the left. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. * - ``neighbor_right_height`` - false - ft - Double - auto - - The height of the neighboring building to the right. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. + - The height of the neighboring building to the right. If not provided, the OS-HPXML default (see `HPXML Neighbor Building `_) is used. Options ******* @@ -48010,7 +48010,7 @@ Arguments - - Double - auto - - Multiplier on internal gains from general water use (floor mopping, shower evaporation, water films on showers, tubs & sinks surfaces, plant watering, etc.) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Building Occupancy `_) is used. + - Multiplier on internal gains from general water use (floor mopping, shower evaporation, water films on showers, tubs & sinks surfaces, plant watering, etc.) that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Building Occupancy `_) is used. Options ******* @@ -48342,19 +48342,19 @@ Arguments - ft - Double - auto - - Elevation of the home address. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. + - Elevation of the home address. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. * - ``site_latitude`` - false - deg - Double - auto - - Latitude of the home address. Must be between -90 and 90. Use negative values for southern hemisphere. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. + - Latitude of the home address. Must be between -90 and 90. Use negative values for southern hemisphere. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. * - ``site_longitude`` - false - deg - Double - auto - - Longitude of the home address. Must be between -180 and 180. Use negative values for the western hemisphere. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. + - Longitude of the home address. Must be between -180 and 180. Use negative values for the western hemisphere. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. Options ******* @@ -60333,19 +60333,19 @@ Arguments - - Choice - auto, standard, premium, thin film - - Module type of the PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - Module type of the PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_location`` - false - - Choice - auto, roof, ground - - Location of the PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - Location of the PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_tracking`` - false - - Choice - auto, fixed, 1-axis, 1-axis backtracked, 2-axis - - Type of tracking for the PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - Type of tracking for the PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_array_tilt`` - true - degrees @@ -60363,13 +60363,13 @@ Arguments - Frac - Double - auto - - Inverter efficiency of the PV system. If there are two PV systems, this will apply to both. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - Inverter efficiency of the PV system. If there are two PV systems, this will apply to both. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_system_losses_fraction`` - false - Frac - Double - auto - - System losses fraction of the PV system. If there are two PV systems, this will apply to both. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - System losses fraction of the PV system. If there are two PV systems, this will apply to both. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_2_present`` - true - @@ -60381,19 +60381,19 @@ Arguments - - Choice - auto, standard, premium, thin film - - Module type of the second PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - Module type of the second PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_2_location`` - false - - Choice - auto, roof, ground - - Location of the second PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - Location of the second PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_2_tracking`` - false - - Choice - auto, fixed, 1-axis, 1-axis backtracked, 2-axis - - Type of tracking for the second PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. + - Type of tracking for the second PV system. If not provided, the OS-HPXML default (see `HPXML Photovoltaics `_) is used. * - ``pv_system_2_array_tilt`` - true - degrees @@ -60689,37 +60689,37 @@ Arguments - kWh/yr - Double - auto - - The annual energy consumption of the television plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - The annual energy consumption of the television plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_television_usage_multiplier`` - false - - Double - auto - - Multiplier on the television energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - Multiplier on the television energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_other_annual_kwh`` - false - kWh/yr - Double - auto - - The annual energy consumption of the other residual plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - The annual energy consumption of the other residual plug loads. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_other_frac_sensible`` - false - Frac - Double - auto - - Fraction of other residual plug loads' internal gains that are sensible. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - Fraction of other residual plug loads' internal gains that are sensible. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_other_frac_latent`` - false - Frac - Double - auto - - Fraction of other residual plug loads' internal gains that are latent. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - Fraction of other residual plug loads' internal gains that are latent. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. * - ``misc_plug_loads_other_usage_multiplier`` - false - - Double - auto - - Multiplier on the other energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. + - Multiplier on the other energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Plug Loads `_) is used. Options ******* @@ -61377,7 +61377,7 @@ Arguments - - Choice - auto, 1, 2, 3 - - The grade of the radiant barrier in the attic. If not provided, the OS-HPXML default (see `HPXML Roofs `_) is used. + - The grade of the radiant barrier in the attic. If not provided, the OS-HPXML default (see `HPXML Roofs `_) is used. Options ******* @@ -61446,31 +61446,31 @@ Arguments - # - Integer - auto - - The quantity of the kitchen fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The quantity of the kitchen fans. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``kitchen_fans_flow_rate`` - false - CFM - Double - auto - - The flow rate of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The flow rate of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``kitchen_fans_hours_in_operation`` - false - hrs/day - Double - auto - - The hours in operation of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The hours in operation of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``kitchen_fans_power`` - false - W - Double - auto - - The fan power of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The fan power of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. * - ``kitchen_fans_start_hour`` - false - hr - Integer - auto - - The start hour of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. + - The start hour of the kitchen fan. If not provided, the OS-HPXML default (see `HPXML Local Ventilation Fans `_) is used. Options ******* @@ -61736,13 +61736,13 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The space type for the refrigerator location. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. + - The space type for the refrigerator location. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. * - ``refrigerator_rated_annual_kwh`` - false - kWh/yr - Double - auto - - The EnergyGuide rated annual energy consumption for a refrigerator. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. + - The EnergyGuide rated annual energy consumption for a refrigerator. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. Options ******* @@ -61851,7 +61851,7 @@ Arguments - - Double - auto - - Multiplier on the refrigerator energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. + - Multiplier on the refrigerator energy usage that can reflect, e.g., high/low usage occupants. If not provided, the OS-HPXML default (see `HPXML Refrigerators `_) is used. Options ******* @@ -61928,13 +61928,13 @@ Arguments - - Choice - auto, asphalt or fiberglass shingles, concrete, cool roof, slate or tile shingles, expanded polystyrene sheathing, metal surfacing, plastic/rubber/synthetic sheeting, shingles, wood shingles or shakes - - The material type of the roof. If not provided, the OS-HPXML default (see `HPXML Roofs `_) is used. + - The material type of the roof. If not provided, the OS-HPXML default (see `HPXML Roofs `_) is used. * - ``roof_color`` - false - - Choice - auto, dark, light, medium, medium dark, reflective - - The color of the roof. If not provided, the OS-HPXML default (see `HPXML Roofs `_) is used. + - The color of the roof. If not provided, the OS-HPXML default (see `HPXML Roofs `_) is used. Options ******* @@ -62069,7 +62069,7 @@ Arguments - gal - Double - auto - - The storage volume of the solar thermal system. If not provided, the OS-HPXML default (see `Detailed Inputs `_) is used. + - The storage volume of the solar thermal system. If not provided, the OS-HPXML default (see `Detailed Inputs `_) is used. * - ``solar_thermal_solar_fraction`` - true - Frac @@ -62154,7 +62154,7 @@ Arguments - - Choice - auto, AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY - - State code of the home address. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. + - State code of the home address. If not provided, the OS-HPXML default (see `HPXML Site `_) is used. Options ******* @@ -62756,7 +62756,7 @@ Arguments - gal - Double - auto - - Nominal volume of water heater tank. If not provided, the OS-HPXML default (see `Conventional Storage `_, `Heat Pump `_, `Combi Boiler w/ Storage `_) is used. + - Nominal volume of water heater tank. If not provided, the OS-HPXML default (see `Conventional Storage `_, `Heat Pump `_, `Combi Boiler w/ Storage `_) is used. * - ``water_heater_efficiency_type`` - true - @@ -62774,31 +62774,31 @@ Arguments - - Choice - auto, very small, low, medium, high - - The usage of the water heater. Only applies if Efficiency Type is UniformEnergyFactor and Type is not instantaneous water heater. Does not apply to space-heating boilers. If not provided, the OS-HPXML default (see `Conventional Storage `_, `Heat Pump `_) is used. + - The usage of the water heater. Only applies if Efficiency Type is UniformEnergyFactor and Type is not instantaneous water heater. Does not apply to space-heating boilers. If not provided, the OS-HPXML default (see `Conventional Storage `_, `Heat Pump `_) is used. * - ``water_heater_recovery_efficiency`` - false - Frac - Double - auto - - Ratio of energy delivered to water heater to the energy content of the fuel consumed by the water heater. Only used for non-electric storage water heaters. If not provided, the OS-HPXML default (see `Conventional Storage `_) is used. + - Ratio of energy delivered to water heater to the energy content of the fuel consumed by the water heater. Only used for non-electric storage water heaters. If not provided, the OS-HPXML default (see `Conventional Storage `_) is used. * - ``water_heater_heating_capacity`` - false - Btu/hr - Double - auto - - Heating capacity. Only applies to storage water heater and heat pump water heater (compressor). If not provided, the OS-HPXML default (see `Conventional Storage `_, `Heat Pump `_) is used. + - Heating capacity. Only applies to storage water heater and heat pump water heater (compressor). If not provided, the OS-HPXML default (see `Conventional Storage `_, `Heat Pump `_) is used. * - ``water_heater_backup_heating_capacity`` - false - Btu/hr - Double - auto - - Backup heating capacity for a heat pump water heater. If not provided, the OS-HPXML default (see `Heat Pump `_) is used. + - Backup heating capacity for a heat pump water heater. If not provided, the OS-HPXML default (see `Heat Pump `_) is used. * - ``water_heater_standby_loss`` - false - 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 `_) is used. + - The standby loss of water heater. Only applies to space-heating boilers. If not provided, the OS-HPXML default (see `Combi Boiler w/ Storage `_) is used. * - ``water_heater_jacket_rvalue`` - false - h-ft^2-R/Btu @@ -62810,7 +62810,7 @@ Arguments - F - Double - auto - - The setpoint temperature of water heater. If not provided, the OS-HPXML default (see `HPXML Water Heating Systems `_) is used. + - The setpoint temperature of water heater. If not provided, the OS-HPXML default (see `HPXML Water Heating Systems `_) is used. * - ``water_heater_num_bedrooms_served`` - false - # @@ -62828,13 +62828,13 @@ Arguments - - Choice - auto, mixed, stratified - - Type of tank model to use. The 'stratified' tank generally provide more accurate results, but may significantly increase run time. Applies only to storage water heater. If not provided, the OS-HPXML default (see `Conventional Storage `_) is used. + - Type of tank model to use. The 'stratified' tank generally provide more accurate results, but may significantly increase run time. Applies only to storage water heater. If not provided, the OS-HPXML default (see `Conventional Storage `_) is used. * - ``water_heater_operating_mode`` - false - - Choice - auto, hybrid/auto, heat pump only - - The water heater operating mode. The 'heat pump only' option only uses the heat pump, while 'hybrid/auto' allows the backup electric resistance to come on in high demand situations. This is ignored if a scheduled operating mode type is selected. Applies only to heat pump water heater. If not provided, the OS-HPXML default (see `Heat Pump `_) is used. + - The water heater operating mode. The 'heat pump only' option only uses the heat pump, while 'hybrid/auto' allows the backup electric resistance to come on in high demand situations. This is ignored if a scheduled operating mode type is selected. Applies only to heat pump water heater. If not provided, the OS-HPXML default (see `Heat Pump `_) is used. * - ``water_heater_has_flue_or_chimney`` - true - @@ -63368,7 +63368,7 @@ Arguments - - Choice - auto, conditioned space, basement - conditioned, basement - unconditioned, garage, attic, attic - vented, attic - unvented, crawlspace, crawlspace - vented, crawlspace - unvented, crawlspace - conditioned, other exterior, other housing unit, other heated space, other multifamily buffer space, other non-freezing space - - The location of water heater. If not provided, the OS-HPXML default (see `HPXML Water Heating Systems `_) is used. + - The location of water heater. If not provided, the OS-HPXML default (see `HPXML Water Heating Systems `_) is used. Options ******* @@ -63732,7 +63732,7 @@ Arguments - Days/week - Integer - auto - - For operable windows, the number of days/week that windows can be opened by occupants for natural ventilation. If not provided, the OS-HPXML default (see `HPXML Windows `_) is used. + - For operable windows, the number of days/week that windows can be opened by occupants for natural ventilation. If not provided, the OS-HPXML default (see `HPXML Windows `_) is used. * - ``window_ufactor`` - true - Btu/hr-ft^2-R @@ -63750,25 +63750,25 @@ Arguments - - Choice - auto, solar film, solar screens, none - - Type of window exterior shading. Summer/winter shading coefficients can be provided below instead. If neither is provided, the OS-HPXML default (see `HPXML Exterior Shading `_) is used. + - Type of window exterior shading. Summer/winter shading coefficients can be provided below instead. If neither is provided, the OS-HPXML default (see `HPXML Exterior Shading `_) is used. * - ``window_exterior_shading_winter`` - false - Frac - Double - auto - - Exterior shading coefficient for the winter season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Exterior Shading `_) is used. + - Exterior shading coefficient for the winter season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Exterior Shading `_) is used. * - ``window_exterior_shading_summer`` - false - Frac - Double - auto - - Exterior shading coefficient for the summer season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Exterior Shading `_) is used. + - Exterior shading coefficient for the summer season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see `HPXML Exterior Shading `_) is used. * - ``window_shading_summer_season`` - false - - String - auto - - Enter a date range like 'May 1 - Sep 30'. Defines the summer season for purposes of shading coefficients; the rest of the year is assumed to be winter. If not provided, the OS-HPXML default (see `HPXML Windows `_) is used. + - Enter a date range like 'May 1 - Sep 30'. Defines the summer season for purposes of shading coefficients; the rest of the year is assumed to be winter. If not provided, the OS-HPXML default (see `HPXML Windows `_) is used. * - ``window_insect_screens`` - false -