Residential HPXML Workflow Generator
workflow_generator: type: residential_hpxml args: build_existing_model: simulation_control_run_period_calendar_year: 2010 add_component_loads: false emissions: - scenario_name: Scenario1 type: CO2e elec_folder: data/cambium/LRMER_MidCase_15 utility_bills: - scenario_name: Bills1 gas_marginal_rate: 1.05 pv_compensation_type: NetMetering simulation_output_report: timeseries_frequency: hourly include_timeseries_total_consumptions: true include_timeseries_fuel_consumptions: true include_timeseries_end_use_consumptions: true include_timeseries_emissions: true output_variables: - name: Zone People Occupant Count reporting_measures: - measure_dir_name: QOIReport server_directory_cleanup: retain_in_osm: true retain_in_idf: false retain_eplusout_rdd: true debug: false
simulation_control_timestep: Value must be a divisor of 60. Units are minutes.
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.
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.
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.
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.
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.
add_component_loads: If true, output the annual heating/cooling component loads. Using this comes with a small runtime performance penalty.
emissions(optional): Add these arguments to the BuildExistingModel measure for performing emissions calculations.
scenario_name: Name of the emissions scenario.
type: Type of emission (e.g., CO2e, NOx, etc.).
elec_folder: Folder of schedule files with hourly electricity emissions factors values. Units are kg/MWh. Folder path is relative to buildstock_directory’s resources folder. File names must contain GEA region names.
gas_value: Annual emissions factor for natural gas. Units are lb/MBtu (million Btu).
propane_value: Annual emissions factor for propane. Units are lb/MBtu (million Btu).
oil_value: Annual emissions factor for fuel oil. Units are lb/MBtu (million Btu).
wood_value: Annual emissions factor for wood. Units are lb/MBtu (million Btu).
utility_bills(optional): Add these arguments to the BuildExistingModel measure for performing utility bill calculations.
scenario_name: Name of the utility bills scenario.
simple_filepath: TSV file with all fixed charge / marginal rate / PV argument values for each option of a chosen parameter (e.g., State). These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory’s resources folder.
detailed_filepath: TSV file with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charge / marginal rate / PV argument values. These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory’s resources folder. Electricity tariff paths are relative to the parent folder of the
elec_fixed_charge: Monthly fixed charge for electricity.
elec_marginal_rate: Marginal rate for electricity. Units are $/kWh.
gas_fixed_charge: Monthly fixed charge for natural gas.
gas_marginal_rate: Marginal rate for natural gas. Units are $/therm.
propane_fixed_charge: Monthly fixed charge for propane.
propane_marginal_rate: Marginal rate for propane. Units are $/gallon.
oil_fixed_charge: Monthly fixed charge for fuel oil.
oil_marginal_rate: Marginal rate for fuel oil. Units are $/gallon.
wood_fixed_charge: Monthly fixed charge for wood.
wood_marginal_rate: Marginal rate for wood. Units are $/kBtu.
pv_compensation_type: Photovoltaic compensation types. Can be NetMetering or FeedInTariff.
pv_net_metering_annual_excess_sellback_rate_type: Photovoltaic net metering annual excess sellback rate type. Can be User-Specified or Retail Electricity Cost. Applies if compensation type is NetMetering.
pv_net_metering_annual_excess_sellback_rate: Photovoltaic net metering annual excess sellback rate. Applies if compensation type is NetMetering.
pv_feed_in_tariff_rate: Photovoltaic annual full/gross feed-in tariff rate. Applies if compensation type is FeedInTariff.
pv_monthly_grid_connection_fee_units: Photovoltaic monthly grid connection fee units. Can be $ or $/kW.
pv_monthly_grid_connection_fee: Photovoltaic monthly grid connection fee.
measures(optional): Add these optional measures to the end of your workflow.
measure_dir_name: Name of measure directory.
arguments: map of key, value arguments to pass to the measure.
timeseries_frequency: The frequency at which to report timeseries output data. Using ‘none’ will disable timeseries outputs. Valid choices are ‘none’, ‘timestep’, ‘hourly’, ‘daily’, and ‘monthly’.
include_timeseries_total_consumptions: Generates timeseries energy consumptions for the total building.
include_timeseries_fuel_consumptions: Generates timeseries energy consumptions for each fuel type (in kBtu for fossil fuels and kWh for electricity).
include_timeseries_end_use_consumptions: Generates timeseries energy consumptions for each end use type (in kBtu for fossil fuels and kWh for electricity).
include_timeseries_emissions: Generates timeseries emissions (e.g., CO2). Requires the appropriate HPXML inputs to be specified.
include_timeseries_emission_fuels: Generates timeseries emissions for each fuel type. Requires the appropriate HPXML inputs to be specified.
include_timeseries_emission_end_uses: Generates timeseries emissions for each end use. Requires the appropriate HPXML inputs to be specified.
include_timeseries_hot_water_uses: Generates timeseries hot water usages for each end use type (in gallons).
include_timeseries_total_loads: Generates timeseries total heating, cooling, and hot water loads (in kBtu) for the building.
include_timeseries_component_loads: Generates timeseries heating and cooling loads (in kBtu) disaggregated by component type (e.g., Walls, Windows, Infiltration, Ducts, etc.).
include_timeseries_unmet_hours: Generates timeseries unmet hours for heating and cooling.
include_timeseries_zone_temperatures: Generates timeseries average temperatures (in deg-F) for each space modeled (e.g., living space, attic, garage, basement, crawlspace, etc.).
include_timeseries_airflows: Generates timeseries airflow rates (in cfm) for infiltration, mechanical ventilation (including clothes dryer exhaust), natural ventilation, whole house fans.
include_timeseries_weather: Generates timeseries weather file data including outdoor temperatures, relative humidity, wind speed, and solar.
include_timeseries_resilience: Generates timeseries resilience outputs.
timeseries_timestamp_convention: Determines whether timeseries timestamps use the start-of-timestep or end-of-timestep convention. Valid choices are ‘start’ and ‘end’.
timeseries_num_decimal_places: Allows overriding the default number of decimal places for timeseries 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.
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.
output_variables: Optionally request EnergyPlus output variables. Do not include key values; by default all key values will be requested.
reporting_measures(optional): A list of additional reporting measures to apply to the workflow. Any columns reported by these additional measures will be appended to the results csv. Note: For upgrade runs, do not add
ApplyUpgradeto the list of reporting measures, doing so will cause run to fail prematurely.
ApplyUpgradeis applied automatically when the
upgradeskey is supplied.
measure_dir_name: Name of measure directory.
arguments: map of key, value arguments to pass to the measure.
server_directory_cleanup(optional): Optionally preserve or delete various simulation output files. These arguments are passed directly to the ServerDirectoryCleanup measure in resstock. Please refer to the measure arguments there to determine what to set them to in your config file. Note that the default behavior is to retain some files and remove others. See Server Directory Cleanup Defaults for current defaults.
debug(optional): Optionally enable debug mode. Enabling debug mode will preserve all simulation input and output files, including but not limited to: in.osm, all EnergyPlus output files, and intermediate existing and upgraded files (e.g., OSWs and XMLs).
Build Existing Model Defaults
'simulation_control_timestep': 60, 'simulation_control_run_period_begin_month': 1, 'simulation_control_run_period_begin_day_of_month': 1, 'simulation_control_run_period_end_month': 12, 'simulation_control_run_period_end_day_of_month': 31, 'simulation_control_run_period_calendar_year': 2007, 'add_component_loads': False
Simulation Output Report Defaults
'timeseries_frequency': 'none', 'include_timeseries_total_consumptions': False, 'include_timeseries_fuel_consumptions': False, 'include_timeseries_end_use_consumptions': True, 'include_timeseries_emissions': False, 'include_timeseries_emission_fuels': False, 'include_timeseries_emission_end_uses': False, 'include_timeseries_hot_water_uses': False, 'include_timeseries_total_loads': True, 'include_timeseries_component_loads': False, 'include_timeseries_zone_temperatures': False, 'include_timeseries_airflows': False, 'include_timeseries_weather': False, 'timeseries_timestamp_convention': 'end', 'add_timeseries_dst_column': True, 'add_timeseries_utc_column': True
Server Directory Cleanup Defaults
'retain_in_osm': False, 'retain_in_idf': True, 'retain_pre_process_idf': False, 'retain_eplusout_audit': False, 'retain_eplusout_bnd': False, 'retain_eplusout_eio': False, 'retain_eplusout_end': False, 'retain_eplusout_err': False, 'retain_eplusout_eso': False, 'retain_eplusout_mdd': False, 'retain_eplusout_mtd': False, 'retain_eplusout_rdd': False, 'retain_eplusout_shd': False, 'retain_eplusout_msgpack': False, 'retain_eplustbl_htm': False, 'retain_stdout_energyplus': False, 'retain_stdout_expandobject': False, 'retain_schedules_csv': True, 'debug': debug