Default Outputs
The default set of outputs include sampled housing characteristics, annual simulation outputs, and upgrade cost information.
Specifying any timeseries frequency other than “none” results in, by default, end use consumptions and total loads timeseries output requests.
See the Residential HPXML Workflow Generator documentation page (i.e., simulation_output_report section) for more information on how to request various timeseries outputs (or override default requests).
Housing Characteristics
Default characteristics include sampled properties for each dwelling unit.
Input Name |
Input Description |
|---|---|
build_existing_model.ahs_region |
|
build_existing_model.aiannh_area |
|
build_existing_model.area_median_income |
|
build_existing_model.ashrae_iecc_climate_zone_2004 |
|
build_existing_model.ashrae_iecc_climate_zone_2004_2_a_split |
|
build_existing_model.bathroom_spot_vent_hour |
|
build_existing_model.battery |
|
build_existing_model.bedrooms |
|
build_existing_model.building_america_climate_zone |
|
build_existing_model.cec_climate_zone |
|
build_existing_model.ceiling_fan |
|
build_existing_model.census_division |
|
build_existing_model.census_division_recs |
|
build_existing_model.census_region |
|
build_existing_model.city |
|
build_existing_model.clothes_dryer |
|
build_existing_model.clothes_dryer_usage_level |
|
build_existing_model.clothes_washer |
|
build_existing_model.clothes_washer_presence |
|
build_existing_model.clothes_washer_usage_level |
|
build_existing_model.cooking_range |
|
build_existing_model.cooking_range_usage_level |
|
build_existing_model.cooling_setpoint |
|
build_existing_model.cooling_setpoint_has_offset |
|
build_existing_model.cooling_setpoint_offset_magnitude |
|
build_existing_model.cooling_setpoint_offset_period |
|
build_existing_model.corridor |
|
build_existing_model.county |
|
build_existing_model.county_and_puma |
|
build_existing_model.county_metro_status |
|
build_existing_model.custom_state |
|
build_existing_model.dehumidifier |
|
build_existing_model.dishwasher |
|
build_existing_model.dishwasher_usage_level |
|
build_existing_model.door_area |
|
build_existing_model.doors |
|
build_existing_model.duct_leakage_and_insulation |
|
build_existing_model.duct_location |
|
build_existing_model.eaves |
|
build_existing_model.electric_vehicle |
|
build_existing_model.energystar_climate_zone_2023 |
|
build_existing_model.federal_poverty_level |
|
build_existing_model.generation_and_emissions_assessment_region |
|
build_existing_model.geometry_attic_type |
|
build_existing_model.geometry_building_horizontal_location_mf |
|
build_existing_model.geometry_building_horizontal_location_sfa |
|
build_existing_model.geometry_building_level_mf |
|
build_existing_model.geometry_building_number_units_mf |
|
build_existing_model.geometry_building_number_units_sfa |
|
build_existing_model.geometry_building_type_acs |
|
build_existing_model.geometry_building_type_height |
|
build_existing_model.geometry_building_type_recs |
|
build_existing_model.geometry_floor_area |
|
build_existing_model.geometry_floor_area_bin |
|
build_existing_model.geometry_foundation_type |
|
build_existing_model.geometry_garage |
|
build_existing_model.geometry_space_combination |
|
build_existing_model.geometry_stories |
|
build_existing_model.geometry_stories_low_rise |
|
build_existing_model.geometry_story_bin |
|
build_existing_model.geometry_wall_exterior_finish |
|
build_existing_model.geometry_wall_type |
|
build_existing_model.ground_thermal_conductivity |
|
build_existing_model.has_pv |
|
build_existing_model.heating_fuel |
|
build_existing_model.heating_setpoint |
|
build_existing_model.heating_setpoint_has_offset |
|
build_existing_model.heating_setpoint_offset_magnitude |
|
build_existing_model.heating_setpoint_offset_period |
|
build_existing_model.holiday_lighting |
|
build_existing_model.hot_water_distribution |
|
build_existing_model.hot_water_fixtures |
|
build_existing_model.household_has_tribal_persons |
|
build_existing_model.hvac_cooling_autosizing_factor |
|
build_existing_model.hvac_cooling_efficiency |
|
build_existing_model.hvac_cooling_partial_space_conditioning |
|
build_existing_model.hvac_cooling_type |
|
build_existing_model.hvac_has_ducts |
|
build_existing_model.hvac_has_shared_system |
|
build_existing_model.hvac_has_zonal_electric_heating |
|
build_existing_model.hvac_heating_autosizing_factor |
|
build_existing_model.hvac_heating_efficiency |
|
build_existing_model.hvac_heating_type |
|
build_existing_model.hvac_heating_type_and_fuel |
|
build_existing_model.hvac_secondary_heating_efficiency |
|
build_existing_model.hvac_secondary_heating_fuel |
|
build_existing_model.hvac_secondary_heating_partial_space_conditioning |
|
build_existing_model.hvac_secondary_heating_type |
|
build_existing_model.hvac_shared_efficiencies |
|
build_existing_model.hvac_system_is_faulted |
|
build_existing_model.hvac_system_is_scaled |
|
build_existing_model.hvac_system_single_speed_ac_airflow |
|
build_existing_model.hvac_system_single_speed_ac_charge |
|
build_existing_model.hvac_system_single_speed_ashp_airflow |
|
build_existing_model.hvac_system_single_speed_ashp_charge |
|
build_existing_model.income |
|
build_existing_model.income_recs_2015 |
|
build_existing_model.income_recs_2020 |
|
build_existing_model.infiltration |
|
build_existing_model.insulation_ceiling |
|
build_existing_model.insulation_floor |
|
build_existing_model.insulation_foundation_wall |
|
build_existing_model.insulation_rim_joist |
|
build_existing_model.insulation_roof |
|
build_existing_model.insulation_slab |
|
build_existing_model.insulation_wall |
|
build_existing_model.interior_shading |
|
build_existing_model.iso_rto_region |
|
build_existing_model.lighting |
|
build_existing_model.lighting_interior_use |
|
build_existing_model.lighting_other_use |
|
build_existing_model.location_region |
|
build_existing_model.mechanical_ventilation |
|
build_existing_model.metropolitan_and_micropolitan_statistical_area |
|
build_existing_model.misc_extra_refrigerator |
|
build_existing_model.misc_freezer |
|
build_existing_model.misc_gas_fireplace |
|
build_existing_model.misc_gas_grill |
|
build_existing_model.misc_gas_lighting |
|
build_existing_model.misc_hot_tub_spa |
|
build_existing_model.misc_pool |
|
build_existing_model.misc_pool_heater |
|
build_existing_model.misc_pool_pump |
|
build_existing_model.misc_well_pump |
|
build_existing_model.natural_ventilation |
|
build_existing_model.neighbors |
|
build_existing_model.occupants |
|
build_existing_model.orientation |
|
build_existing_model.overhangs |
|
build_existing_model.plug_load_diversity |
|
build_existing_model.plug_loads |
|
build_existing_model.puma |
|
build_existing_model.puma_metro_status |
|
build_existing_model.pv_orientation |
|
build_existing_model.pv_system_size |
|
build_existing_model.radiant_barrier |
|
build_existing_model.range_spot_vent_hour |
|
build_existing_model.reeds_balancing_area |
|
build_existing_model.refrigerator |
|
build_existing_model.refrigerator_usage_level |
|
build_existing_model.roof_material |
|
build_existing_model.solar_hot_water |
|
build_existing_model.state |
|
build_existing_model.state_metro_median_income |
|
build_existing_model.tenure |
|
build_existing_model.usage_level |
|
build_existing_model.vacancy_status |
|
build_existing_model.vintage |
|
build_existing_model.vintage_acs |
|
build_existing_model.water_heater_efficiency |
|
build_existing_model.water_heater_fuel |
|
build_existing_model.water_heater_in_unit |
|
build_existing_model.water_heater_location |
|
build_existing_model.window_areas |
|
build_existing_model.windows |
Simulation Outputs
Default annual simulation outputs include energy consumptions (total, by fuel, and by end use), hot water uses, building loads, unmet hours, peak building electricity/loads, HVAC capacities, and HVAC design temperatures/loads.
See the OpenStudio-HPXML Workflow Outputs sections on Annual Outputs and Timeseries Outputs for more information about annual outputs.
Annual Name |
Annual Units |
Timeseries ResStock Name |
Timeseries BuildStockBatch Name |
Timeseries Units |
Notes |
|---|---|---|---|---|---|
report_simulation_output.end_use_coal_clothes_dryer_m_btu |
MBtu |
End Use: Coal: Clothes Dryer |
end_use__coal__clothes_dryer__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_fireplace_m_btu |
MBtu |
End Use: Coal: Fireplace |
end_use__coal__fireplace__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_generator_m_btu |
MBtu |
End Use: Coal: Generator |
end_use__coal__generator__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_grill_m_btu |
MBtu |
End Use: Coal: Grill |
end_use__coal__grill__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_heating_heat_pump_backup_m_btu |
MBtu |
End Use: Coal: Heating Heat Pump Backup |
end_use__coal__heating_heat_pump_backup__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_heating_m_btu |
MBtu |
End Use: Coal: Heating |
end_use__coal__heating__kbtu |
kBtu |
Excludes heat pump backup |
report_simulation_output.end_use_coal_hot_water_m_btu |
MBtu |
End Use: Coal: Hot Water |
end_use__coal__hot_water__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_lighting_m_btu |
MBtu |
End Use: Coal: Lighting |
end_use__coal__lighting__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_mech_vent_preheating_m_btu |
MBtu |
End Use: Coal: Mech Vent Preheating |
end_use__coal__mech_vent_preheating__kbtu |
kBtu |
|
report_simulation_output.end_use_coal_range_oven_m_btu |
MBtu |
End Use: Coal: Range/Oven |
end_use__coal__range_oven__kbtu |
kBtu |
|
report_simulation_output.end_use_electricity_battery_m_btu |
MBtu |
End Use: Electricity: Battery |
end_use__electricity__battery__kwh |
kWh |
Positive value for charging (including efficiency losses); negative value for discharging |
report_simulation_output.end_use_electricity_ceiling_fan_m_btu |
MBtu |
End Use: Electricity: Ceiling Fan |
end_use__electricity__ceiling_fan__kwh |
kWh |
|
report_simulation_output.end_use_electricity_clothes_dryer_m_btu |
MBtu |
End Use: Electricity: Clothes Dryer |
end_use__electricity__clothes_dryer__kwh |
kWh |
|
report_simulation_output.end_use_electricity_clothes_washer_m_btu |
MBtu |
End Use: Electricity: Clothes Washer |
end_use__electricity__clothes_washer__kwh |
kWh |
|
report_simulation_output.end_use_electricity_cooling_fans_pumps_m_btu |
MBtu |
End Use: Electricity: Cooling Fans/Pumps |
end_use__electricity__cooling_fans_pumps__kwh |
kWh |
Supply fan (air distribution) or circulating pump (geothermal loop) |
report_simulation_output.end_use_electricity_cooling_m_btu |
MBtu |
End Use: Electricity: Cooling |
end_use__electricity__cooling__kwh |
kWh |
Excludes fans/pumps |
report_simulation_output.end_use_electricity_dehumidifier_m_btu |
MBtu |
End Use: Electricity: Dehumidifier |
end_use__electricity__dehumidifier__kwh |
kWh |
|
report_simulation_output.end_use_electricity_dishwasher_m_btu |
MBtu |
End Use: Electricity: Dishwasher |
end_use__electricity__dishwasher__kwh |
kWh |
|
report_simulation_output.end_use_electricity_electric_vehicle_charging_m_btu |
MBtu |
End Use: Electricity: Electric Vehicle Charging |
end_use__electricity__electric_vehicle_charging__kwh |
kWh |
|
report_simulation_output.end_use_electricity_freezer_m_btu |
MBtu |
End Use: Electricity: Freezer |
end_use__electricity__freezer__kwh |
kWh |
|
report_simulation_output.end_use_electricity_generator_m_btu |
MBtu |
End Use: Electricity: Generator |
end_use__electricity__generator__kwh |
kWh |
Negative value for any power produced |
report_simulation_output.end_use_electricity_heating_fans_pumps_m_btu |
MBtu |
End Use: Electricity: Heating Fans/Pumps |
end_use__electricity__heating_fans_pumps__kwh |
kWh |
Supply fan (air distribution) or circulating pump (hydronic distribution or geothermal loop) |
report_simulation_output.end_use_electricity_heating_heat_pump_backup_m_btu |
MBtu |
End Use: Electricity: Heating Heat Pump Backup |
end_use__electricity__heating_heat_pump_backup__kwh |
kWh |
Excludes heat pump backup fans/pumps |
report_simulation_output.end_use_electricity_heating_heat_pump_backup_fans_pumps_m_btu |
MBtu |
End Use: Electricity: Heating Heat Pump Backup Fans/Pumps |
end_use__electricity__heating_heat_pump_backup_fans_pumps__kwh |
kWh |
Includes supply fan (air distribution) or circulating pump (hydronic distribution) during heat pump backup |
report_simulation_output.end_use_electricity_heating_m_btu |
MBtu |
End Use: Electricity: Heating |
end_use__electricity__heating__kwh |
kWh |
Excludes heat pump backup and fans/pumps |
report_simulation_output.end_use_electricity_permanent_spa_heater_m_btu |
MBtu |
End Use: Electricity: Permanent Spa Heater |
end_use__electricity__permanent_spa_heater__kwh |
kWh |
|
report_simulation_output.end_use_electricity_permanent_spa_pump_m_btu |
MBtu |
End Use: Electricity: Permanent Spa Pump |
end_use__electricity__permanent_spa_pump__kwh |
kWh |
|
report_simulation_output.end_use_electricity_hot_water_m_btu |
MBtu |
End Use: Electricity: Hot Water |
end_use__electricity__hot_water__kwh |
kWh |
Excludes recirc pump and solar thermal pump |
report_simulation_output.end_use_electricity_hot_water_recirc_pump_m_btu |
MBtu |
End Use: Electricity: Hot Water Recirc Pump |
end_use__electricity__hot_water_recirc_pump__kwh |
kWh |
|
report_simulation_output.end_use_electricity_hot_water_solar_thermal_pump_m_btu |
MBtu |
End Use: Electricity: Hot Water Solar Thermal Pump |
end_use__electricity__hot_water_solar_thermal_pump__kwh |
kWh |
Non-zero only when using detailed (not simple) solar thermal inputs |
report_simulation_output.end_use_electricity_lighting_exterior_m_btu |
MBtu |
End Use: Electricity: Lighting Exterior |
end_use__electricity__lighting_exterior__kwh |
kWh |
Includes exterior holiday lighting |
report_simulation_output.end_use_electricity_lighting_garage_m_btu |
MBtu |
End Use: Electricity: Lighting Garage |
end_use__electricity__lighting_garage__kwh |
kWh |
|
report_simulation_output.end_use_electricity_lighting_interior_m_btu |
MBtu |
End Use: Electricity: Lighting Interior |
end_use__electricity__lighting_interior__kwh |
kWh |
|
report_simulation_output.end_use_electricity_mech_vent_m_btu |
MBtu |
End Use: Electricity: Mech Vent |
end_use__electricity__mech_vent__kwh |
kWh |
Excludes preheating/precooling |
report_simulation_output.end_use_electricity_mech_vent_precooling_m_btu |
MBtu |
End Use: Electricity: Mech Vent Precooling |
end_use__electricity__mech_vent_precooling__kwh |
kWh |
|
report_simulation_output.end_use_electricity_mech_vent_preheating_m_btu |
MBtu |
End Use: Electricity: Mech Vent Preheating |
end_use__electricity__mech_vent_preheating__kwh |
kWh |
|
report_simulation_output.end_use_electricity_plug_loads_m_btu |
MBtu |
End Use: Electricity: Plug Loads |
end_use__electricity__plug_loads__kwh |
kWh |
Excludes independently reported plug loads (e.g., well pump) |
report_simulation_output.end_use_electricity_pool_heater_m_btu |
MBtu |
End Use: Electricity: Pool Heater |
end_use__electricity__pool_heater__kwh |
kWh |
|
report_simulation_output.end_use_electricity_pool_pump_m_btu |
MBtu |
End Use: Electricity: Pool Pump |
end_use__electricity__pool_pump__kwh |
kWh |
|
report_simulation_output.end_use_electricity_pv_m_btu |
MBtu |
End Use: Electricity: PV |
end_use__electricity__pv__kwh |
kWh |
Negative value for any power produced |
report_simulation_output.end_use_electricity_range_oven_m_btu |
MBtu |
End Use: Electricity: Range/Oven |
end_use__electricity__range_oven__kwh |
kWh |
|
report_simulation_output.end_use_electricity_refrigerator_m_btu |
MBtu |
End Use: Electricity: Refrigerator |
end_use__electricity__refrigerator__kwh |
kWh |
|
report_simulation_output.end_use_electricity_television_m_btu |
MBtu |
End Use: Electricity: Television |
end_use__electricity__television__kwh |
kWh |
|
report_simulation_output.end_use_electricity_well_pump_m_btu |
MBtu |
End Use: Electricity: Well Pump |
end_use__electricity__well_pump__kwh |
kWh |
|
report_simulation_output.end_use_electricity_whole_house_fan_m_btu |
MBtu |
End Use: Electricity: Whole House Fan |
end_use__electricity__whole_house_fan__kwh |
kWh |
|
report_simulation_output.end_use_fuel_oil_clothes_dryer_m_btu |
MBtu |
End Use: Fuel Oil: Clothes Dryer |
end_use__fuel_oil__clothes_dryer__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_fireplace_m_btu |
MBtu |
End Use: Fuel Oil: Fireplace |
end_use__fuel_oil__fireplace__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_generator_m_btu |
MBtu |
End Use: Fuel Oil: Generator |
end_use__fuel_oil__generator__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_grill_m_btu |
MBtu |
End Use: Fuel Oil: Grill |
end_use__fuel_oil__grill__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_heating_heat_pump_backup_m_btu |
MBtu |
End Use: Fuel Oil: Heating Heat Pump Backup |
end_use__fuel_oil__heating_heat_pump_backup__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_heating_m_btu |
MBtu |
End Use: Fuel Oil: Heating |
end_use__fuel_oil__heating__kbtu |
kBtu |
Excludes heat pump backup |
report_simulation_output.end_use_fuel_oil_hot_water_m_btu |
MBtu |
End Use: Fuel Oil: Hot Water |
end_use__fuel_oil__hot_water__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_lighting_m_btu |
MBtu |
End Use: Fuel Oil: Lighting |
end_use__fuel_oil__lighting__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_mech_vent_preheating_m_btu |
MBtu |
End Use: Fuel Oil: Mech Vent Preheating |
end_use__fuel_oil__mech_vent_preheating__kbtu |
kBtu |
|
report_simulation_output.end_use_fuel_oil_range_oven_m_btu |
MBtu |
End Use: Fuel Oil: Range/Oven |
end_use__fuel_oil__range_oven__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_clothes_dryer_m_btu |
MBtu |
End Use: Natural Gas: Clothes Dryer |
end_use__natural_gas__clothes_dryer__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_fireplace_m_btu |
MBtu |
End Use: Natural Gas: Fireplace |
end_use__natural_gas__fireplace__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_generator_m_btu |
MBtu |
End Use: Natural Gas: Generator |
end_use__natural_gas__generator__kbtu |
kBtu |
Positive value for any fuel consumed |
report_simulation_output.end_use_natural_gas_grill_m_btu |
MBtu |
End Use: Natural Gas: Grill |
end_use__natural_gas__grill__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_heating_heat_pump_backup_m_btu |
MBtu |
End Use: Natural Gas: Heating Heat Pump Backup |
end_use__natural_gas__heating_heat_pump_backup__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_heating_m_btu |
MBtu |
End Use: Natural Gas: Heating |
end_use__natural_gas__heating__kbtu |
kBtu |
Excludes heat pump backup |
report_simulation_output.end_use_natural_gas_permanent_spa_heater_m_btu |
MBtu |
End Use: Natural Gas: Permanent Spa Heater |
end_use__natural_gas__permanent_spa_heater__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_hot_water_m_btu |
MBtu |
End Use: Natural Gas: Hot Water |
end_use__natural_gas__hot_water__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_lighting_m_btu |
MBtu |
End Use: Natural Gas: Lighting |
end_use__natural_gas__lighting__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_mech_vent_preheating_m_btu |
MBtu |
End Use: Natural Gas: Mech Vent Preheating |
end_use__natural_gas__mech_vent_preheating__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_pool_heater_m_btu |
MBtu |
End Use: Natural Gas: Pool Heater |
end_use__natural_gas__pool_heater__kbtu |
kBtu |
|
report_simulation_output.end_use_natural_gas_range_oven_m_btu |
MBtu |
End Use: Natural Gas: Range/Oven |
end_use__natural_gas__range_oven__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_clothes_dryer_m_btu |
MBtu |
End Use: Propane: Clothes Dryer |
end_use__propane__clothes_dryer__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_fireplace_m_btu |
MBtu |
End Use: Propane: Fireplace |
end_use__propane__fireplace__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_generator_m_btu |
MBtu |
End Use: Propane: Generator |
end_use__propane__generator__kbtu |
kBtu |
Positive value for any fuel consumed |
report_simulation_output.end_use_propane_grill_m_btu |
MBtu |
End Use: Propane: Grill |
end_use__propane__grill__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_heating_heat_pump_backup_m_btu |
MBtu |
End Use: Propane: Heating Heat Pump Backup |
end_use__propane__heating_heat_pump_backup__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_heating_m_btu |
MBtu |
End Use: Propane: Heating |
end_use__propane__heating__kbtu |
kBtu |
Excludes heat pump backup |
report_simulation_output.end_use_propane_hot_water_m_btu |
MBtu |
End Use: Propane: Hot Water |
end_use__propane__hot_water__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_lighting_m_btu |
MBtu |
End Use: Propane: Lighting |
end_use__propane__lighting__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_mech_vent_preheating_m_btu |
MBtu |
End Use: Propane: Mech Vent Preheating |
end_use__propane__mech_vent_preheating__kbtu |
kBtu |
|
report_simulation_output.end_use_propane_range_oven_m_btu |
MBtu |
End Use: Propane: Range/Oven |
end_use__propane__range_oven__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_clothes_dryer_m_btu |
MBtu |
End Use: Wood Cord: Clothes Dryer |
end_use__wood_cord__clothes_dryer__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_fireplace_m_btu |
MBtu |
End Use: Wood Cord: Fireplace |
end_use__wood_cord__fireplace__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_generator_m_btu |
MBtu |
End Use: Wood Cord: Generator |
end_use__wood_cord__generator__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_grill_m_btu |
MBtu |
End Use: Wood Cord: Grill |
end_use__wood_cord__grill__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_heating_heat_pump_backup_m_btu |
MBtu |
End Use: Wood Cord: Heating Heat Pump Backup |
end_use__wood_cord__heating_heat_pump_backup__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_heating_m_btu |
MBtu |
End Use: Wood Cord: Heating |
end_use__wood_cord__heating__kbtu |
kBtu |
Excludes heat pump backup |
report_simulation_output.end_use_wood_cord_hot_water_m_btu |
MBtu |
End Use: Wood Cord: Hot Water |
end_use__wood_cord__hot_water__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_lighting_m_btu |
MBtu |
End Use: Wood Cord: Lighting |
end_use__wood_cord__lighting__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_mech_vent_preheating_m_btu |
MBtu |
End Use: Wood Cord: Mech Vent Preheating |
end_use__wood_cord__mech_vent_preheating__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_cord_range_oven_m_btu |
MBtu |
End Use: Wood Cord: Range/Oven |
end_use__wood_cord__range_oven__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_clothes_dryer_m_btu |
MBtu |
End Use: Wood Pellets: Clothes Dryer |
end_use__wood_pellets__clothes_dryer__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_fireplace_m_btu |
MBtu |
End Use: Wood Pellets: Fireplace |
end_use__wood_pellets__fireplace__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_generator_m_btu |
MBtu |
End Use: Wood Pellets: Generator |
end_use__wood_pellets__generator__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_grill_m_btu |
MBtu |
End Use: Wood Pellets: Grill |
end_use__wood_pellets__grill__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_heating_heat_pump_backup_m_btu |
MBtu |
End Use: Wood Pellets: Heating Heat Pump Backup |
end_use__wood_pellets__heating_heat_pump_backup__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_heating_m_btu |
MBtu |
End Use: Wood Pellets: Heating |
end_use__wood_pellets__heating__kbtu |
kBtu |
Excludes heat pump backup |
report_simulation_output.end_use_wood_pellets_hot_water_m_btu |
MBtu |
End Use: Wood Pellets: Hot Water |
end_use__wood_pellets__hot_water__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_lighting_m_btu |
MBtu |
End Use: Wood Pellets: Lighting |
end_use__wood_pellets__lighting__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_mech_vent_preheating_m_btu |
MBtu |
End Use: Wood Pellets: Mech Vent Preheating |
end_use__wood_pellets__mech_vent_preheating__kbtu |
kBtu |
|
report_simulation_output.end_use_wood_pellets_range_oven_m_btu |
MBtu |
End Use: Wood Pellets: Range/Oven |
end_use__wood_pellets__range_oven__kbtu |
kBtu |
|
report_simulation_output.energy_use_net_m_btu |
MBtu |
Energy Use: Net |
energy_use__net__kbtu |
kBtu |
Subtracts any power produced by PV or generators. |
report_simulation_output.energy_use_total_m_btu |
MBtu |
Energy Use: Total |
energy_use__total__kbtu |
kBtu |
Includes any battery charging/discharging |
report_simulation_output.fuel_use_coal_total_m_btu |
MBtu |
Fuel Use: Coal: Total |
fuel_use__coal__total__kwh |
kBtu |
Includes ‘coal’, ‘anthracite coal’, ‘bituminous coal’, and ‘coke’. |
report_simulation_output.fuel_use_electricity_net_m_btu |
MBtu |
Fuel Use: Electricity: Net |
fuel_use__electricity__net__kwh |
kWh |
Subtracts any power produced by PV or generators. |
report_simulation_output.fuel_use_electricity_total_m_btu |
MBtu |
Fuel Use: Electricity: Total |
fuel_use__electricity__total__kwh |
kWh |
Includes any battery charging/discharging |
report_simulation_output.fuel_use_fuel_oil_total_m_btu |
MBtu |
Fuel Use: Fuel Oil: Total |
fuel_use__fuel_oil__total__kbtu |
kBtu |
Includes ‘fuel oil’, ‘fuel oil 1’, ‘fuel oil 2’, ‘fuel oil 4’, ‘fuel oil 5/6’, ‘kerosene’, and ‘diesel’ |
report_simulation_output.fuel_use_natural_gas_total_m_btu |
MBtu |
Fuel Use: Natural Gas: Total |
fuel_use__natural_gas__total__kbtu |
kBtu |
|
report_simulation_output.fuel_use_propane_total_m_btu |
MBtu |
Fuel Use: Propane: Total |
fuel_use__propane__total__kbtu |
kBtu |
|
report_simulation_output.fuel_use_wood_cord_total_m_btu |
MBtu |
Fuel Use: Wood Cord: Total |
fuel_use__wood_cord__total__kbtu |
kBtu |
|
report_simulation_output.fuel_use_wood_pellets_total_m_btu |
MBtu |
Fuel Use: Wood Pellets: Total |
fuel_use__wood_pellets__total__kbtu |
kBtu |
|
report_simulation_output.hot_water_clothes_washer_gal |
gal |
Hot Water: Clothes Washer |
hot_water__clothes_washer__gal |
gal |
|
report_simulation_output.hot_water_dishwasher_gal |
gal |
Hot Water: Dishwasher |
hot_water__dishwasher__gal |
gal |
|
report_simulation_output.hot_water_distribution_waste_gal |
gal |
Hot Water: Distribution Waste |
hot_water__distribution_waste__gal |
gal |
|
report_simulation_output.hot_water_fixtures_gal |
gal |
Hot Water: Fixtures |
hot_water__fixtures__gal |
gal |
Showers and faucets. |
report_simulation_output.hvac_capacity_cooling_btu_h |
Btu/h |
Total HVAC cooling capacity |
|||
report_simulation_output.hvac_capacity_heat_pump_backup_btu_h |
Btu/h |
Total HVAC heat pump backup capacity |
|||
report_simulation_output.hvac_capacity_heating_btu_h |
Btu/h |
Total HVAC heating capacity |
|||
report_simulation_output.hvac_design_load_cooling_latent_ducts_btu_h |
Btu/h |
Latent cooling design load for ducts |
|||
report_simulation_output.hvac_design_load_cooling_latent_infiltration_ventilation_btu_h |
Btu/h |
Latent cooling design load for infiltration/ventilation |
|||
report_simulation_output.hvac_design_load_cooling_latent_internal_gains_btu_h |
Btu/h |
Latent cooling design load for internal gains |
|||
report_simulation_output.hvac_design_load_cooling_latent_total_btu_h |
Btu/h |
Total latent cooling design load |
|||
report_simulation_output.hvac_design_load_cooling_sensible_ceilings_btu_h |
Btu/h |
Sensible cooling design load for ceilings |
|||
report_simulation_output.hvac_design_load_cooling_sensible_doors_btu_h |
Btu/h |
Sensible cooling design load for doors |
|||
report_simulation_output.hvac_design_load_cooling_sensible_ducts_btu_h |
Btu/h |
Sensible cooling design load for ducts |
|||
report_simulation_output.hvac_design_load_cooling_sensible_floors_btu_h |
Btu/h |
Sensible cooling design load for floors |
|||
report_simulation_output.hvac_design_load_cooling_sensible_infiltration_ventilation_btu_h |
Btu/h |
Sensible cooling design load for infiltration/ventilation |
|||
report_simulation_output.hvac_design_load_cooling_sensible_internal_gains_btu_h |
Btu/h |
Sensible cooling design load for internal gains |
|||
report_simulation_output.hvac_design_load_cooling_sensible_roofs_btu_h |
Btu/h |
Sensible cooling design load for roofs |
|||
report_simulation_output.hvac_design_load_cooling_sensible_skylights_btu_h |
Btu/h |
Sensible cooling design load for skylights |
|||
report_simulation_output.hvac_design_load_cooling_sensible_slabs_btu_h |
Btu/h |
Sensible cooling design load for slabs |
|||
report_simulation_output.hvac_design_load_cooling_sensible_total_btu_h |
Btu/h |
Total sensible cooling design load |
|||
report_simulation_output.hvac_design_load_cooling_sensible_walls_btu_h |
Btu/h |
Sensible cooling design load for walls |
|||
report_simulation_output.hvac_design_load_cooling_sensible_windows_btu_h |
Btu/h |
Sensible cooling design load for windows |
|||
report_simulation_output.hvac_design_load_heating_ceilings_btu_h |
Btu/h |
Heating design load for ceilings |
|||
report_simulation_output.hvac_design_load_heating_doors_btu_h |
Btu/h |
Heating design load for doors |
|||
report_simulation_output.hvac_design_load_heating_ducts_btu_h |
Btu/h |
Heating design load for ducts |
|||
report_simulation_output.hvac_design_load_heating_floors_btu_h |
Btu/h |
Heating design load for floors |
|||
report_simulation_output.hvac_design_load_heating_infiltration_ventilation_btu_h |
Btu/h |
Heating design load for infiltration/ventilation |
|||
report_simulation_output.hvac_design_load_heating_roofs_btu_h |
Btu/h |
Heating design load for roofs |
|||
report_simulation_output.hvac_design_load_heating_skylights_btu_h |
Btu/h |
Heating design load for skylights |
|||
report_simulation_output.hvac_design_load_heating_slabs_btu_h |
Btu/h |
Heating design load for slabs |
|||
report_simulation_output.hvac_design_load_heating_total_btu_h |
Btu/h |
Total heating design load |
|||
report_simulation_output.hvac_design_load_heating_walls_btu_h |
Btu/h |
Heating design load for walls |
|||
report_simulation_output.hvac_design_load_heating_windows_btu_h |
Btu/h |
Heating design load for windows |
|||
report_simulation_output.hvac_design_temperature_cooling_f |
F |
1% cooling drybulb temperature |
|||
report_simulation_output.hvac_design_temperature_heating_f |
F |
99% heating drybulb temperature |
|||
report_simulation_output.load_cooling_delivered_m_btu |
MBtu |
Load: Cooling: Delivered |
load__cooling__delivered__kbtu |
kBtu |
Includes HVAC distribution losses. |
report_simulation_output.load_heating_heat_pump_backup_m_btu |
MBtu |
Load: Heating: Heat Pump Backup |
load__heating__heat_pump_backup__kbtu |
kBtu |
Heating load delivered by the heat pump backup only, including distribution losses. |
report_simulation_output.load_heating_delivered_m_btu |
MBtu |
Load: Heating: Delivered |
load__heating__delivered__kbtu |
kBtu |
Includes HVAC distribution losses. |
report_simulation_output.load_hot_water_delivered_m_btu |
MBtu |
Load: Hot Water: Delivered |
load__hot_water__delivered__kbtu |
kBtu |
Includes contributions by desuperheaters or solar thermal systems. |
report_simulation_output.load_hot_water_desuperheater_m_btu |
MBtu |
Load: Hot Water: Desuperheater |
load__hot_water__desuperheater__kbtu |
kBtu |
Load served by the desuperheater. |
report_simulation_output.load_hot_water_solar_thermal_m_btu |
MBtu |
Load: Hot Water: Solar Thermal |
load__hot_water__solar_thermal__kbtu |
kBtu |
Load served by the solar thermal system. |
report_simulation_output.load_hot_water_tank_losses_m_btu |
MBtu |
Load: Hot Water: Tank Losses |
load__hot_water__tank_losses__kbtu |
kBtu |
|
report_simulation_output.peak_electricity_annual_total_w |
W |
Maximum value in any month |
|||
report_simulation_output.peak_electricity_summer_total_w |
W |
Maximum value in Jun/Jul/Aug (or Dec/Jan/Feb in the southern hemisphere) |
|||
report_simulation_output.peak_electricity_winter_total_w |
W |
Maximum value in Dec/Jan/Feb (or Jun/Jul/Aug in the southern hemisphere) |
|||
report_simulation_output.peak_load_cooling_delivered_k_btu_hr |
kBtu/hr |
Includes HVAC distribution losses. |
|||
report_simulation_output.peak_load_heating_delivered_k_btu_hr |
kBtu/hr |
Includes HVAC distribution losses. |
|||
report_simulation_output.resilience_battery_hr |
hr |
Resilience: Battery |
resilience__battery__hr |
hr |
Average length of time the battery state of charge can meet the electric load |
report_simulation_output.unmet_hours_cooling_hr |
hr |
Unmet Hours: Cooling |
unmet_hours__cooling__hr |
hr |
Number of hours where the cooling setpoint is not maintained. |
report_simulation_output.unmet_hours_heating_hr |
hr |
Unmet Hours: Heating |
unmet_hours__heating__hr |
hr |
Number of hours where the heating setpoint is not maintained. |
Upgrade Costs
Cost multiplier types include:
Annual Name |
Annual Units |
Notes |
|---|---|---|
upgrade_costs.door_area_ft_2 |
ft^2 |
Door Area |
upgrade_costs.duct_unconditioned_surface_area_ft_2 |
ft^2 |
Duct Unconditioned Surface Area |
upgrade_costs.floor_area_attic_ft_2 |
ft^2 |
Floor Area, Attic |
upgrade_costs.floor_area_attic_insulation_increase_ft_2_delta_r_value |
ft^2 * Delta R-value |
Floor Area, Attic * Insulation Increase |
upgrade_costs.floor_area_conditioned_ft_2 |
ft^2 |
Floor Area, Conditioned |
upgrade_costs.floor_area_conditioned_infiltration_reduction_ft_2_delta_ach_50 |
ft^2 * Delta ACH50 |
Floor Area, Conditioned * Infiltration Reduction |
upgrade_costs.floor_area_foundation_ft_2 |
ft^2 |
Floor Area, Foundation |
upgrade_costs.floor_area_lighting_ft_2 |
ft^2 |
Floor Area, Lighting |
upgrade_costs.flow_rate_mechanical_ventilation_cfm |
cfm |
Flow Rate, Mechanical Ventilation |
upgrade_costs.rim_joist_area_above_grade_exterior_ft_2 |
ft^2 |
Rim Joist Area, Above-Grade, Exterior |
upgrade_costs.roof_area_ft_2 |
ft^2 |
Roof Area |
upgrade_costs.size_cooling_system_primary_k_btu_h |
kBtu/h |
Size, Cooling System Primary |
upgrade_costs.size_heat_pump_backup_primary_k_btu_h |
kBtu/h |
Size, Heat Pump Backup Primary |
upgrade_costs.size_heating_system_primary_k_btu_h |
kBtu/h |
Size, Heating System Primary |
upgrade_costs.size_heating_system_secondary_k_btu_h |
kBtu/h |
Size, Heating System Secondary |
upgrade_costs.size_water_heater_gal |
gal |
Size, Water Heater |
upgrade_costs.slab_perimeter_exposed_conditioned_ft |
ft |
Slab Perimeter, Exposed, Conditioned |
upgrade_costs.wall_area_above_grade_conditioned_ft_2 |
ft^2 |
Wall Area, Above-Grade, Conditioned |
upgrade_costs.wall_area_above_grade_exterior_ft_2 |
ft^2 |
Wall Area, Above-Grade, Exterior |
upgrade_costs.wall_area_below_grade_ft_2 |
ft^2 |
Wall Area, Below-Grade |
upgrade_costs.window_area_ft_2 |
ft^2 |
Window Area |
Note that “Fixed (1)” is also a valid cost multiplier type.
When upgrades are applied, additional outputs are reported. They are listed below.
Annual Name |
Annual Units |
Notes |
|---|---|---|
upgrade_costs.option_<#>_name |
The Parameter|Option applied. |
|
upgrade_costs.option_<#>_cost_usd |
$ |
The option cost (value * multiplier). |
upgrade_costs.option_<#>_lifetime_yrs |
years |
The option lifetime. |
upgrade_costs.upgrade_cost_usd |
$ |
Total cost of the upgrade. |
where <#> represents any of the defined option numbers. See Upgrade Scenario Configuration for more information.
Note
Currently, you can enter up to 25 options per upgrade. See Increasing Upgrade Options for more information on how to allow additional options per upgrade.
Note that the name, cost, and lifetime information will only be populated when applicable for a given upgrade option (i.e., when the apply logic evaluates as true).
Other Outputs
Input Name |
Input Description |
|---|---|
building_id |
The building unit number (between 1 and the number of samples). |
job_id |
The unique identifier of the job/processor. |
started_at |
Simulation start time. |
completed_at |
Simulation end time. |
completed_status |
Simulation Success, Fail, or Invalid. |
build_existing_model.applicable |
The measure was applied to the workflow. |
build_existing_model.sample_weight |
Number of buildings this simulation represents. |
build_existing_model.units_represented |
The number of dwelling units this simulation represents. Should always be one. |
build_existing_model.emissions_electricity_folders |
Relative paths of electricity emissions factor schedule files with hourly values. Paths are relative to the resources folder. If multiple scenarios, use a comma-separated list. File names must contain GEA region names. |
build_existing_model.emissions_electricity_units |
Electricity emissions factors units. If multiple scenarios, use a comma-separated list. Only lb/MWh and kg/MWh are allowed. |
build_existing_model.emissions_electricity_values_or_filepaths |
Electricity emissions factors values, specified as either an annual factor or an absolute/relative path to a file with hourly factors. If multiple scenarios, use a comma-separated list. |
build_existing_model.emissions_fossil_fuel_units |
Fossil fuel emissions factors units. If multiple scenarios, use a comma-separated list. Only lb/MBtu and kg/MBtu are allowed. |
build_existing_model.emissions_fuel_oil_values |
Fuel oil emissions factors values, specified as an annual factor. If multiple scenarios, use a comma-separated list. |
build_existing_model.emissions_natural_gas_values |
Natural gas emissions factors values, specified as an annual factor. If multiple scenarios, use a comma-separated list. |
build_existing_model.emissions_propane_values |
Propane emissions factors values, specified as an annual factor. If multiple scenarios, use a comma-separated list. |
build_existing_model.emissions_scenario_names |
Names of emissions scenarios. If multiple scenarios, use a comma-separated list. |
build_existing_model.emissions_types |
Types of emissions (e.g., CO2e, NOx, etc.). If multiple scenarios, use a comma-separated list. |
build_existing_model.emissions_wood_values |
Wood emissions factors values, specified as an annual factor. If multiple scenarios, use a comma-separated list. |
build_existing_model.simulation_control_run_period_begin_day_of_month |
This numeric field should contain the starting day of the starting month (must be valid for month) for the annual run period desired. |
build_existing_model.simulation_control_run_period_begin_month |
This numeric field should contain the starting month number (1 = January, 2 = February, etc.) for the annual run period desired. |
build_existing_model.simulation_control_run_period_calendar_year |
This numeric field should contain the calendar year that determines the start day of week. If you are running simulations using AMY weather files, the value entered for calendar year will not be used; it will be overridden by the actual year found in the AMY weather file. |
build_existing_model.simulation_control_run_period_end_day_of_month |
This numeric field should contain the ending day of the ending month (must be valid for month) for the annual run period desired. |
build_existing_model.simulation_control_run_period_end_month |
This numeric field should contain the end month number (1 = January, 2 = February, etc.) for the annual run period desired. |
build_existing_model.simulation_control_timestep |
Value must be a divisor of 60. |
build_existing_model.utility_bill_detailed_filepaths |
Relative paths of detailed utility rates. Paths are relative to the resources folder. If multiple scenarios, use a comma-separated list. Files must contain the name of the Parameter as the column header. |
build_existing_model.utility_bill_electricity_filepaths |
Electricity tariff file specified as an absolute/relative path to a file with utility rate structure information. Tariff file must be formatted to OpenEI API version 7. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_electricity_fixed_charges |
Electricity utility bill monthly fixed charges. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_electricity_marginal_rates |
Electricity utility bill marginal rates. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_fuel_oil_fixed_charges |
Fuel oil utility bill monthly fixed charges. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_fuel_oil_marginal_rates |
Fuel oil utility bill marginal rates. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_natural_gas_fixed_charges |
Natural gas utility bill monthly fixed charges. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_natural_gas_marginal_rates |
Natural gas utility bill marginal rates. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_propane_fixed_charges |
Propane utility bill monthly fixed charges. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_propane_marginal_rates |
Propane utility bill marginal rates. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_pv_compensation_types |
Utility bill PV compensation types. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_pv_feed_in_tariff_rates |
Utility bill PV annual full/gross feed-in tariff rates. Only applies if the PV compensation type is ‘FeedInTariff’. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_pv_monthly_grid_connection_fee_units |
Utility bill PV monthly grid connection fee units. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_pv_monthly_grid_connection_fees |
Utility bill PV monthly grid connection fees. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_pv_net_metering_annual_excess_sellback_rate_types |
Utility bill PV net metering annual excess sellback rate types. Only applies if the PV compensation type is ‘NetMetering’. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_pv_net_metering_annual_excess_sellback_rates |
Utility bill PV net metering annual excess sellback rates. Only applies if the PV compensation type is ‘NetMetering’ and the PV annual excess sellback rate type is ‘User-Specified’. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_scenario_names |
Names of utility bill scenarios. If multiple scenarios, use a comma-separated list. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_simple_filepaths |
Relative paths of simple utility rates. Paths are relative to the resources folder. If multiple scenarios, use a comma-separated list. Files must contain the name of the Parameter as the column header. |
build_existing_model.utility_bill_wood_fixed_charges |
Wood utility bill monthly fixed charges. If multiple scenarios, use a comma-separated list. |
build_existing_model.utility_bill_wood_marginal_rates |
Wood utility bill marginal rates. If multiple scenarios, use a comma-separated list. |
build_existing_model.weather_file_city |
City from the EPW weather file. |
build_existing_model.weather_file_latitude |
Latitude from the EPW weather file. |
build_existing_model.weather_file_longitude |
Longitude from the EPW weather file. |
apply_upgrade.applicable |
The measure was applied to the workflow. |
apply_upgrade.upgrade_name |
User-specificed name that describes the upgrade. |
apply_upgrade.reference_scenario |
The upgrade_name which should act as a reference to this upgrade to calculate savings. |
report_simulation_output.applicable |
The measure was applied to the workflow. |
report_simulation_output.output_format |
The file format of the annual (and timeseries, if requested) outputs. If ‘csv_dview’ is selected, the timeseries CSV file will include header rows that facilitate opening the file in the DView application. |
report_simulation_output.timeseries_frequency |
The frequency at which to report timeseries output data. Using ‘none’ will disable timeseries outputs. |
report_simulation_output.include_annual_total_consumptions |
Generates annual energy consumptions for the total building. |
report_simulation_output.include_annual_fuel_consumptions |
Generates annual energy consumptions for each fuel type. |
report_simulation_output.include_annual_end_use_consumptions |
Generates annual energy consumptions for each end use. |
report_simulation_output.include_annual_system_use_consumptions |
Generates annual energy consumptions for each end use of each HVAC and water heating system. |
report_simulation_output.include_annual_emissions |
Generates annual emissions. Requires the appropriate HPXML inputs to be specified. |
report_simulation_output.include_annual_emission_fuels |
Generates annual emissions for each fuel type. Requires the appropriate HPXML inputs to be specified. |
report_simulation_output.include_annual_emission_end_uses |
Generates annual emissions for each end use. Requires the appropriate HPXML inputs to be specified. |
report_simulation_output.include_annual_total_loads |
Generates annual heating, cooling, and hot water loads. |
report_simulation_output.include_annual_unmet_hours |
Generates annual unmet hours for heating and cooling. |
report_simulation_output.include_annual_peak_fuels |
Generates annual electricity peaks for summer/winter. |
report_simulation_output.include_annual_peak_loads |
Generates annual peak loads for heating/cooling. |
report_simulation_output.include_annual_component_loads |
Generates annual heating and cooling loads disaggregated by component type. |
report_simulation_output.include_annual_hot_water_uses |
Generates annual hot water usages for each end use. |
report_simulation_output.include_annual_hvac_summary |
Generates HVAC capacities, design temperatures, and design loads. |
report_simulation_output.include_annual_resilience |
Generates annual resilience outputs. |
report_simulation_output.include_timeseries_total_consumptions |
Generates timeseries energy consumptions for the total building. |
report_simulation_output.include_timeseries_fuel_consumptions |
Generates timeseries energy consumptions for each fuel type. |
report_simulation_output.include_timeseries_end_use_consumptions |
Generates timeseries energy consumptions for each end use. |
report_simulation_output.include_timeseries_system_use_consumptions |
Generates timeseries energy consumptions for each end use of each HVAC and water heating system. |
report_simulation_output.include_timeseries_emissions |
Generates timeseries emissions. Requires the appropriate HPXML inputs to be specified. |
report_simulation_output.include_timeseries_emission_fuels |
Generates timeseries emissions for each fuel type. Requires the appropriate HPXML inputs to be specified. |
report_simulation_output.include_timeseries_emission_end_uses |
Generates timeseries emissions for each end use. Requires the appropriate HPXML inputs to be specified. |
report_simulation_output.include_timeseries_hot_water_uses |
Generates timeseries hot water usages for each end use. |
report_simulation_output.include_timeseries_total_loads |
Generates timeseries total heating, cooling, and hot water loads. |
report_simulation_output.include_timeseries_component_loads |
Generates timeseries heating and cooling loads disaggregated by component type. |
report_simulation_output.include_timeseries_unmet_hours |
Generates timeseries unmet hours for heating and cooling. |
report_simulation_output.include_timeseries_zone_temperatures |
Generates timeseries temperatures for each thermal zone. |
report_simulation_output.include_timeseries_airflows |
Generates timeseries airflows. |
report_simulation_output.include_timeseries_weather |
Generates timeseries weather data. |
report_simulation_output.include_timeseries_resilience |
Generates timeseries resilience outputs. |
report_simulation_output.timeseries_timestamp_convention |
Determines whether timeseries timestamps use the start-of-period or end-of-period convention. Doesn’t apply if the output format is ‘csv_dview’. |
report_simulation_output.timeseries_num_decimal_places |
Allows overriding the default number of decimal places for timeseries output. Does not apply if output format is msgpack, where no rounding is performed because there is no file size penalty to storing full precision. |
report_simulation_output.add_timeseries_dst_column |
Optionally add, in addition to the default local standard Time column, a local clock TimeDST column. Requires that daylight saving time is enabled. |
report_simulation_output.add_timeseries_utc_column |
Optionally add, in addition to the default local standard Time column, a local clock TimeUTC column. If the time zone UTC offset is not provided in the HPXML file, the time zone in the EPW header will be used. |
report_simulation_output.user_output_variables |
Optionally generates timeseries EnergyPlus output variables. If multiple output variables are desired, use a comma-separated list. Do not include key values; by default all key values will be requested. Example: “Zone People Occupant Count, Zone People Total Heating Energy” |
report_utility_bills.applicable |
The measure was applied to the workflow. |
report_utility_bills.output_format |
The file format of the annual (and timeseries, if requested) outputs. |
report_utility_bills.include_annual_bills |
Generates annual utility bills. |
report_utility_bills.include_monthly_bills |
Generates monthly utility bills. |
report_utility_bills.monthly_timestamp_convention |
Determines whether monthly timestamps use the start-of-period or end-of-period convention. |
upgrade_costs.applicable |
The measure was applied to the workflow. |
upgrade_costs.debug |
If true, retain existing and upgraded intermediate files. |
upgrade_costs.upgrade_cost_usd |
Total cost of the upgrade. |
qoi_report.applicable |
The measure was applied to the workflow. |