From 1f0604971c9c0db2b5408b84e437b89b69cb9c43 Mon Sep 17 00:00:00 2001 From: Rajendra Adhikari Date: Tue, 9 Jul 2024 11:31:55 -0500 Subject: [PATCH] Add missing test input --- .../measures/ReportHPXMLOutput/measure.xml | 91 + .../measures/UpgradeCosts/measure.xml | 219 ++ .../resources/buildstock.rb | 14 + .../HPXMLtoOpenStudio/measure.xml | 735 +++++++ .../ReportSimulationOutput/measure.xml | 1941 +++++++++++++++++ .../ReportUtilityBills/measure.xml | 354 +++ 6 files changed, 3354 insertions(+) create mode 100644 buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/ReportHPXMLOutput/measure.xml create mode 100644 buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/UpgradeCosts/measure.xml create mode 100644 buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/buildstock.rb create mode 100644 buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml create mode 100644 buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportSimulationOutput/measure.xml create mode 100644 buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportUtilityBills/measure.xml diff --git a/buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/ReportHPXMLOutput/measure.xml b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/ReportHPXMLOutput/measure.xml new file mode 100644 index 00000000..f8f0ed72 --- /dev/null +++ b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/ReportHPXMLOutput/measure.xml @@ -0,0 +1,91 @@ + + + 3.1 + report_hpxml_output + 9561a0d7-60ad-48c5-8337-2461df044d80 + 222e94cd-c586-4745-8cde-55e933a00392 + 2024-01-26T00:28:04Z + 9BF1E6AC + ReportHPXMLOutput + HPXML Output Report + Reports HPXML outputs for residential HPXML-based models. + Parses the HPXML file and reports pre-defined outputs. + + + output_format + Output Format + The file format of the annual (and timeseries, if requested) outputs. + Choice + false + false + csv + + + csv + csv + + + json + json + + + msgpack + msgpack + + + + + + + + Reporting.QAQC + + + + Measure Type + ReportingMeasure + string + + + Intended Software Tool + OpenStudio Application + string + + + Intended Software Tool + Parametric Analysis Tool + string + + + + + README.md + md + readme + 0BB92B1A + + + README.md.erb + erb + readmeerb + 513F28E9 + + + + OpenStudio + 3.2.0 + 3.2.0 + + measure.rb + rb + script + BA1983C8 + + + constants.rb + rb + resource + 64289999 + + + diff --git a/buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/UpgradeCosts/measure.xml b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/UpgradeCosts/measure.xml new file mode 100644 index 00000000..fbf1e61f --- /dev/null +++ b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/measures/UpgradeCosts/measure.xml @@ -0,0 +1,219 @@ + + + 3.1 + upgrade_costs + ef51212c-acc4-48d7-9b29-cf2a5c6c4449 + 91316c37-1384-4da6-bfc7-f3ffff7479bd + 2024-05-16T22:50:36Z + 9BF1E6AC + UpgradeCosts + Upgrade Costs + Measure that calculates upgrade costs. + Multiplies cost value by cost multiplier. + + + debug + Debug Mode? + If true, retain existing and upgraded intermediate files. + Boolean + false + false + false + + + true + true + + + false + false + + + + + + + + Reporting.QAQC + + + + Measure Type + ReportingMeasure + string + + + Intended Software Tool + OpenStudio Application + string + + + Intended Software Tool + Parametric Analysis Tool + string + + + + + README.md + md + readme + 8B802F86 + + + README.md.erb + erb + readmeerb + 513F28E9 + + + + OpenStudio + 3.1.0 + 3.1.0 + + measure.rb + rb + script + 9CBCFE21 + + + MF_1story_UB_Furnace_AC1_FuelTankWH.osw + osw + test + E25C10A6 + + + MF_2story_UB_ASHP2_HPWH.osw + osw + test + 2F063A50 + + + MF_2story_UB_FuelBoiler_AC1_FuelTankWH.osw + osw + test + 00DC06A5 + + + MF_2story_UB_Furnace_AC1_FuelTankWH.osw + osw + test + D96319E6 + + + SFA_2story_FB_FuelBoiler_RoomAC_FuelTankWH.osw + osw + test + 5BB5AEDD + + + SFA_2story_UB_ASHP2_HPWH.osw + osw + test + 9B276DD7 + + + SFA_2story_UB_FuelBoiler_RoomAC_FuelTankWH.osw + osw + test + 48E3E2F1 + + + SFA_2story_UB_Furnace_RoomAC_FuelTankWH.osw + osw + test + DE1353CB + + + SFD_1story_FB_UA_GRG_MSHP_FuelTanklessWH.osw + osw + test + A35D75CF + + + SFD_1story_FB_UA_GRG_RoomAC_ElecBoiler_FuelTanklessWH.osw + osw + test + 671B1CF5 + + + SFD_1story_UB_UA_ASHP2_HPWH.osw + osw + test + 633C8822 + + + SFD_1story_UB_UA_GRG_ACV_FuelFurnace_HPWH.osw + osw + test + BC978C5D + + + SFD_1story_UB_UA_GRG_ACV_FuelFurnace_PortableHeater_HPWH.osw + osw + test + 034E036E + + + SFD_2story_CS_UA_AC2_FuelBoiler_FuelTankWH.osw + osw + test + 3472996A + + + SFD_2story_CS_UA_GRG_ASHPV_FuelTanklessWH.osw + osw + test + 47092F48 + + + SFD_2story_FB_UA_GRG_AC1_ElecBaseboard_FuelTankWH.osw + osw + test + 00347BFF + + + SFD_2story_FB_UA_GRG_AC1_UnitHeater_FuelTankWH.osw + osw + test + B7ADB1FF + + + SFD_2story_FB_UA_GRG_GSHP_ElecTanklessWH.osw + osw + test + 0740B85A + + + SFD_2story_PB_UA_ElecFurnace_ElecTankWH.osw + osw + test + 4368DD0F + + + SFD_2story_S_UA_GRG_ASHP1_Fireplace_FuelTanklessWH.osw + osw + test + 20268BB9 + + + SFD_2story_S_UA_GRG_ASHP1_Fireplace_FuelTanklessWH_ERV.osw + osw + test + 51EB98B2 + + + SFD_2story_S_UA_GRG_ASHP1_FuelTanklessWH.osw + osw + test + 9494BFFE + + + upgrade_costs_test.rb + rb + test + 4695A458 + + + diff --git a/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/buildstock.rb b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/buildstock.rb new file mode 100644 index 00000000..ec9bab1a --- /dev/null +++ b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/buildstock.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true +class Version + ResStock_Version = '3.1.0' # Version of ResStock + BuildStockBatch_Version = '2023.5.0' # Minimum required version of BuildStockBatch + + def self.check_buildstockbatch_version + if ENV.keys.include?('BUILDSTOCKBATCH_VERSION') # buildstockbatch is installed + bsb_version = ENV['BUILDSTOCKBATCH_VERSION'] + if bsb_version < BuildStockBatch_Version + fail "BuildStockBatch version #{BuildStockBatch_Version} or above is required. Found version: #{bsb_version}" + end + end + end +end diff --git a/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml new file mode 100644 index 00000000..a63ced94 --- /dev/null +++ b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/HPXMLtoOpenStudio/measure.xml @@ -0,0 +1,735 @@ + + + 3.1 + hpxm_lto_openstudio + b1543b30-9465-45ff-ba04-1d1f85e763bc + f7324c6c-96bb-456b-a571-6a0b94f8b09f + 2024-06-24T16:04:38Z + D8922A73 + HPXMLtoOpenStudio + HPXML to OpenStudio Translator + Translates HPXML file to OpenStudio Model + TODO + + + hpxml_path + HPXML File Path + Absolute/relative path of the HPXML file. + String + true + false + + + output_dir + Directory for Output Files + Absolute/relative path for the output files directory. + String + true + false + + + output_format + Output Format + The file format of the HVAC design load details output. + Choice + false + false + csv + + + csv + csv + + + json + json + + + msgpack + msgpack + + + + + annual_output_file_name + Annual Output File Name + The name of the file w/ HVAC design loads and capacities. If not provided, defaults to 'results_annual.csv' (or 'results_annual.json' or 'results_annual.msgpack'). + String + false + false + results_annual + + + design_load_details_output_file_name + Design Load Details Output File Name + The name of the file w/ additional HVAC design load details. If not provided, defaults to 'results_design_load_details.csv' (or 'results_design_load_details.json' or 'results_design_load_details.msgpack'). + String + false + false + results_design_load_details + + + add_component_loads + Add component loads? + If true, adds the calculation of heating/cooling component loads (not enabled by default for faster performance). + Boolean + false + false + false + + + true + true + + + false + false + + + + + building_id + BuildingID + The ID of the HPXML Building. Only required if the HPXML has multiple Building elements and WholeSFAorMFBuildingSimulation is not true. + String + false + false + + + skip_validation + Skip Validation? + If true, bypasses HPXML input validation for faster performance. WARNING: This should only be used if the supplied HPXML file has already been validated against the Schema & Schematron documents. + Boolean + false + false + false + + + true + true + + + false + false + + + + + debug + Debug Mode? + If true: 1) Writes in.osm file, 2) Generates additional log output, and 3) Creates all EnergyPlus output files. + Boolean + false + false + false + + + true + true + + + false + false + + + + + + + + Whole Building.Space Types + + + + Measure Type + ModelMeasure + string + + + Intended Software Tool + Apply Measure Now + string + + + Intended Software Tool + OpenStudio Application + string + + + Intended Software Tool + Parametric Analysis Tool + string + + + + + README.md + md + readme + 394CB1D5 + + + README.md.erb + erb + readmeerb + 513F28E9 + + + + OpenStudio + 3.3.0 + 3.3.0 + + measure.rb + rb + script + 4BE710AB + + + airflow.rb + rb + resource + 7F6AAB8C + + + battery.rb + rb + resource + 35D69D97 + + + constants.rb + rb + resource + E4B33E44 + + + constructions.rb + rb + resource + F7E9C33A + + + data/Xing_okstate_0664D_13659_Table_A-3.csv + csv + resource + 50B7055C + + + data/ashrae_622_wsf.csv + csv + resource + 308F75BA + + + data/cambium/LRMER_95DecarbBy2035.csv + csv + resource + 5E60A9EE + + + data/cambium/LRMER_95DecarbBy2050.csv + csv + resource + 01B9A892 + + + data/cambium/LRMER_HighRECosts.csv + csv + resource + A46DE564 + + + data/cambium/LRMER_LowRECosts.csv + csv + resource + 58B8E01E + + + data/cambium/LRMER_MidCase.csv + csv + resource + 4C7D519B + + + data/cambium/README.md + md + resource + FC171B98 + + + data/climate_zones.csv + csv + resource + 63C6A1E2 + + + data/g_functions/C_configurations_5m_v1.0.json + json + resource + E97DCCDD + + + data/g_functions/L_configurations_5m_v1.0.json + json + resource + 6B2B3787 + + + data/g_functions/LopU_configurations_5m_v1.0.json + json + resource + B13FA813 + + + data/g_functions/Open_configurations_5m_v1.0.json + json + resource + FF25A024 + + + data/g_functions/README.md + md + resource + 48D1301C + + + data/g_functions/U_configurations_5m_v1.0.json + json + resource + B5BEF270 + + + data/g_functions/rectangle_5m_v1.0.json + json + resource + 25FFB6A8 + + + data/g_functions/util.rb + rb + resource + 763A6843 + + + data/unavailable_periods.csv + csv + resource + 73BFECE2 + + + energyplus.rb + rb + resource + 9AEB32F1 + + + generator.rb + rb + resource + 121A1933 + + + geometry.rb + rb + resource + CDF82DF7 + + + hotwater_appliances.rb + rb + resource + DC5153B2 + + + hpxml.rb + rb + resource + FEEDB03A + + + hpxml_defaults.rb + rb + resource + FA727ECC + + + hpxml_schema/HPXML.xsd + xsd + resource + DE05BDEC + + + hpxml_schema/README.md + md + resource + D05DFB8A + + + hpxml_schematron/EPvalidator.xml + xml + resource + AE34574D + + + hpxml_schematron/iso-schematron.xsd + xsd + resource + 2785B05C + + + hvac.rb + rb + resource + DBD9E002 + + + hvac_sizing.rb + rb + resource + 1E606DE3 + + + lighting.rb + rb + resource + 79446799 + + + location.rb + rb + resource + 646D452D + + + materials.rb + rb + resource + 3F00DA1A + + + meta_measure.rb + rb + resource + 576F5D3F + + + minitest_helper.rb + rb + resource + 923B05E5 + + + misc_loads.rb + rb + resource + 303A81E7 + + + output.rb + rb + resource + 75C259E5 + + + psychrometrics.rb + rb + resource + 55A3DEFC + + + pv.rb + rb + resource + 01A63349 + + + schedule_files/battery.csv + csv + resource + 971B85EE + + + schedule_files/hvac-variable-system-maximum-power-ratios-varied.csv + csv + resource + B93B3701 + + + schedule_files/occupancy-non-stochastic.csv + csv + resource + A54803E1 + + + schedule_files/occupancy-stochastic-10-mins.csv + csv + resource + F88479B3 + + + schedule_files/occupancy-stochastic-30-mins.csv + csv + resource + F88479B3 + + + schedule_files/occupancy-stochastic.csv + csv + resource + B0187567 + + + schedule_files/occupancy-stochastic_2.csv + csv + resource + 86E85543 + + + schedule_files/occupancy-stochastic_3.csv + csv + resource + 902A544E + + + schedule_files/occupancy-stochastic_4.csv + csv + resource + 3A0C7E92 + + + schedule_files/occupancy-stochastic_5.csv + csv + resource + F0FB0913 + + + schedule_files/occupancy-stochastic_6.csv + csv + resource + B071AE65 + + + schedule_files/setpoints-10-mins.csv + csv + resource + BC2195A6 + + + schedule_files/setpoints-cooling-only.csv + csv + resource + 7465D8DD + + + schedule_files/setpoints-daily-schedules.csv + csv + resource + A60258DE + + + schedule_files/setpoints-daily-setbacks.csv + csv + resource + 74292B8C + + + schedule_files/setpoints-heating-only.csv + csv + resource + BD935921 + + + schedule_files/setpoints.csv + csv + resource + 706A63BC + + + schedule_files/water-heater-operating-modes.csv + csv + resource + 86F45903 + + + schedule_files/water-heater-setpoints-10-mins.csv + csv + resource + F9C90051 + + + schedule_files/water-heater-setpoints.csv + csv + resource + 2DFF87CD + + + schedules.rb + rb + resource + BB8C823F + + + simcontrols.rb + rb + resource + 24E3F0EE + + + unit_conversions.rb + rb + resource + 3B50EF19 + + + util.rb + rb + resource + 23DC6244 + + + utility_bills.rb + rb + resource + 6DD11F52 + + + version.rb + rb + resource + DC1EB1CF + + + waterheater.rb + rb + resource + A4882A19 + + + weather.rb + rb + resource + 51448764 + + + xmlhelper.rb + rb + resource + 2E605B99 + + + xmlvalidator.rb + rb + resource + B580BE85 + + + test_airflow.rb + rb + test + DDCAE919 + + + test_battery.rb + rb + test + 06598B29 + + + test_defaults.rb + rb + test + B645C92F + + + test_enclosure.rb + rb + test + 4D7C8F6E + + + test_generator.rb + rb + test + C4F6CF9B + + + test_hotwater_appliance.rb + rb + test + E3A99BA1 + + + test_hvac.rb + rb + test + 8CDA3FA3 + + + test_hvac_sizing.rb + rb + test + 36E97140 + + + test_lighting.rb + rb + test + A15B8208 + + + test_location.rb + rb + test + 663B10FB + + + test_miscloads.rb + rb + test + 0135301B + + + test_pv.rb + rb + test + DB1DEFCF + + + test_schedules.rb + rb + test + C6CCF641 + + + test_simcontrols.rb + rb + test + 211EB384 + + + test_validation.rb + rb + test + EE974D71 + + + test_water_heater.rb + rb + test + 485EE23B + + + test_weather.rb + rb + test + 156AAC98 + + + util.rb + rb + test + 71ED3EE3 + + + diff --git a/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportSimulationOutput/measure.xml b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportSimulationOutput/measure.xml new file mode 100644 index 00000000..47c93ba0 --- /dev/null +++ b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportSimulationOutput/measure.xml @@ -0,0 +1,1941 @@ + + + 3.1 + report_simulation_output + df9d170c-c21a-4130-866d-0d46b06073fd + 8a4bb3c5-60d8-4be0-92ba-ed7bd25296ff + 2024-06-20T15:11:53Z + 9BF1E6AC + ReportSimulationOutput + HPXML Simulation Output Report + Reports simulation outputs for residential HPXML-based models. + Processes EnergyPlus simulation outputs in order to generate an annual output file and an optional timeseries output file. + + + output_format + 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. + Choice + false + false + csv + + + csv + csv + + + json + json + + + msgpack + msgpack + + + csv_dview + csv_dview + + + + + include_annual_total_consumptions + Generate Annual Output: Total Consumptions + Generates annual energy consumptions for the total building. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_fuel_consumptions + Generate Annual Output: Fuel Consumptions + Generates annual energy consumptions for each fuel type. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_end_use_consumptions + Generate Annual Output: End Use Consumptions + Generates annual energy consumptions for each end use. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_system_use_consumptions + Generate Annual Output: System Use Consumptions + Generates annual energy consumptions for each end use of each HVAC and water heating system. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_emissions + Generate Annual Output: Emissions + Generates annual emissions. Requires the appropriate HPXML inputs to be specified. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_emission_fuels + Generate Annual Output: Emission Fuel Uses + Generates annual emissions for each fuel type. Requires the appropriate HPXML inputs to be specified. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_emission_end_uses + Generate Annual Output: Emission End Uses + Generates annual emissions for each end use. Requires the appropriate HPXML inputs to be specified. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_total_loads + Generate Annual Output: Total Loads + Generates annual heating, cooling, and hot water loads. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_unmet_hours + Generate Annual Output: Unmet Hours + Generates annual unmet hours for heating and cooling. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_peak_fuels + Generate Annual Output: Peak Fuels + Generates annual electricity peaks for summer/winter. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_peak_loads + Generate Annual Output: Peak Loads + Generates annual peak loads for heating/cooling. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_component_loads + Generate Annual Output: Component Loads + Generates annual heating and cooling loads disaggregated by component type. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_hot_water_uses + Generate Annual Output: Hot Water Uses + Generates annual hot water usages for each end use. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_hvac_summary + Generate Annual Output: HVAC Summary + Generates HVAC capacities, design temperatures, and design loads. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_annual_resilience + Generate Annual Output: Resilience + Generates annual resilience outputs. + Boolean + false + false + true + + + true + true + + + false + false + + + + + timeseries_frequency + Timeseries Reporting Frequency + The frequency at which to report timeseries output data. Using 'none' will disable timeseries outputs. + Choice + false + false + none + + + none + none + + + timestep + timestep + + + hourly + hourly + + + daily + daily + + + monthly + monthly + + + + + include_timeseries_total_consumptions + Generate Timeseries Output: Total Consumptions + Generates timeseries energy consumptions for the total building. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_fuel_consumptions + Generate Timeseries Output: Fuel Consumptions + Generates timeseries energy consumptions for each fuel type. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_end_use_consumptions + Generate Timeseries Output: End Use Consumptions + Generates timeseries energy consumptions for each end use. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_system_use_consumptions + Generate Timeseries Output: System Use Consumptions + Generates timeseries energy consumptions for each end use of each HVAC and water heating system. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_emissions + Generate Timeseries Output: Emissions + Generates timeseries emissions. Requires the appropriate HPXML inputs to be specified. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_emission_fuels + Generate Timeseries Output: Emission Fuel Uses + Generates timeseries emissions for each fuel type. Requires the appropriate HPXML inputs to be specified. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_emission_end_uses + Generate Timeseries Output: Emission End Uses + Generates timeseries emissions for each end use. Requires the appropriate HPXML inputs to be specified. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_hot_water_uses + Generate Timeseries Output: Hot Water Uses + Generates timeseries hot water usages for each end use. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_total_loads + Generate Timeseries Output: Total Loads + Generates timeseries heating, cooling, and hot water loads. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_component_loads + Generate Timeseries Output: Component Loads + Generates timeseries heating and cooling loads disaggregated by component type. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_unmet_hours + Generate Timeseries Output: Unmet Hours + Generates timeseries unmet hours for heating and cooling. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_zone_temperatures + Generate Timeseries Output: Zone Temperatures + Generates timeseries temperatures for each thermal zone. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_airflows + Generate Timeseries Output: Airflows + Generates timeseries airflows. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_weather + Generate Timeseries Output: Weather + Generates timeseries weather data. + Boolean + false + false + false + + + true + true + + + false + false + + + + + include_timeseries_resilience + Generate Timeseries Output: Resilience + Generates timeseries resilience outputs. + Boolean + false + false + false + + + true + true + + + false + false + + + + + timeseries_timestamp_convention + Generate Timeseries Output: 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'. + Choice + false + false + start + + + start + start + + + end + end + + + + + timeseries_num_decimal_places + Generate Timeseries Output: Number of Decimal Places + Allows overriding the default number of decimal places for timeseries output. + Integer + false + false + + + add_timeseries_dst_column + Generate Timeseries Output: Add TimeDST Column + Optionally add, in addition to the default local standard Time column, a local clock TimeDST column. Requires that daylight saving time is enabled. + Boolean + false + false + false + + + true + true + + + false + false + + + + + add_timeseries_utc_column + Generate Timeseries Output: Add TimeUTC 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. + Boolean + false + false + false + + + true + true + + + false + false + + + + + user_output_variables + Generate Timeseries Output: EnergyPlus 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" + String + false + false + + + annual_output_file_name + Annual Output File Name + If not provided, defaults to 'results_annual.csv' (or 'results_annual.json' or 'results_annual.msgpack'). + String + false + false + + + timeseries_output_file_name + Timeseries Output File Name + If not provided, defaults to 'results_timeseries.csv' (or 'results_timeseries.json' or 'results_timeseries.msgpack'). + String + false + false + + + + + energy_use_total_m_btu + energy_use_total_m_btu + energy_use_total_m_btu + Double + false + + + energy_use_net_m_btu + energy_use_net_m_btu + energy_use_net_m_btu + Double + false + + + fuel_use_electricity_total_m_btu + fuel_use_electricity_total_m_btu + fuel_use_electricity_total_m_btu + Double + false + + + fuel_use_natural_gas_total_m_btu + fuel_use_natural_gas_total_m_btu + fuel_use_natural_gas_total_m_btu + Double + false + + + fuel_use_fuel_oil_total_m_btu + fuel_use_fuel_oil_total_m_btu + fuel_use_fuel_oil_total_m_btu + Double + false + + + fuel_use_propane_total_m_btu + fuel_use_propane_total_m_btu + fuel_use_propane_total_m_btu + Double + false + + + fuel_use_wood_cord_total_m_btu + fuel_use_wood_cord_total_m_btu + fuel_use_wood_cord_total_m_btu + Double + false + + + fuel_use_wood_pellets_total_m_btu + fuel_use_wood_pellets_total_m_btu + fuel_use_wood_pellets_total_m_btu + Double + false + + + fuel_use_coal_total_m_btu + fuel_use_coal_total_m_btu + fuel_use_coal_total_m_btu + Double + false + + + end_use_electricity_heating_m_btu + end_use_electricity_heating_m_btu + end_use_electricity_heating_m_btu + Double + false + + + end_use_electricity_heating_fans_pumps_m_btu + end_use_electricity_heating_fans_pumps_m_btu + end_use_electricity_heating_fans_pumps_m_btu + Double + false + + + end_use_electricity_heating_heat_pump_backup_m_btu + end_use_electricity_heating_heat_pump_backup_m_btu + end_use_electricity_heating_heat_pump_backup_m_btu + Double + false + + + end_use_electricity_heating_heat_pump_backup_fans_pumps_m_btu + end_use_electricity_heating_heat_pump_backup_fans_pumps_m_btu + end_use_electricity_heating_heat_pump_backup_fans_pumps_m_btu + Double + false + + + end_use_electricity_cooling_m_btu + end_use_electricity_cooling_m_btu + end_use_electricity_cooling_m_btu + Double + false + + + end_use_electricity_cooling_fans_pumps_m_btu + end_use_electricity_cooling_fans_pumps_m_btu + end_use_electricity_cooling_fans_pumps_m_btu + Double + false + + + end_use_electricity_hot_water_m_btu + end_use_electricity_hot_water_m_btu + end_use_electricity_hot_water_m_btu + Double + false + + + end_use_electricity_hot_water_recirc_pump_m_btu + end_use_electricity_hot_water_recirc_pump_m_btu + end_use_electricity_hot_water_recirc_pump_m_btu + Double + false + + + end_use_electricity_hot_water_solar_thermal_pump_m_btu + end_use_electricity_hot_water_solar_thermal_pump_m_btu + end_use_electricity_hot_water_solar_thermal_pump_m_btu + Double + false + + + end_use_electricity_lighting_interior_m_btu + end_use_electricity_lighting_interior_m_btu + end_use_electricity_lighting_interior_m_btu + Double + false + + + end_use_electricity_lighting_garage_m_btu + end_use_electricity_lighting_garage_m_btu + end_use_electricity_lighting_garage_m_btu + Double + false + + + end_use_electricity_lighting_exterior_m_btu + end_use_electricity_lighting_exterior_m_btu + end_use_electricity_lighting_exterior_m_btu + Double + false + + + end_use_electricity_mech_vent_m_btu + end_use_electricity_mech_vent_m_btu + end_use_electricity_mech_vent_m_btu + Double + false + + + end_use_electricity_mech_vent_preheating_m_btu + end_use_electricity_mech_vent_preheating_m_btu + end_use_electricity_mech_vent_preheating_m_btu + Double + false + + + end_use_electricity_mech_vent_precooling_m_btu + end_use_electricity_mech_vent_precooling_m_btu + end_use_electricity_mech_vent_precooling_m_btu + Double + false + + + end_use_electricity_whole_house_fan_m_btu + end_use_electricity_whole_house_fan_m_btu + end_use_electricity_whole_house_fan_m_btu + Double + false + + + end_use_electricity_refrigerator_m_btu + end_use_electricity_refrigerator_m_btu + end_use_electricity_refrigerator_m_btu + Double + false + + + end_use_electricity_freezer_m_btu + end_use_electricity_freezer_m_btu + end_use_electricity_freezer_m_btu + Double + false + + + end_use_electricity_dehumidifier_m_btu + end_use_electricity_dehumidifier_m_btu + end_use_electricity_dehumidifier_m_btu + Double + false + + + end_use_electricity_dishwasher_m_btu + end_use_electricity_dishwasher_m_btu + end_use_electricity_dishwasher_m_btu + Double + false + + + end_use_electricity_clothes_washer_m_btu + end_use_electricity_clothes_washer_m_btu + end_use_electricity_clothes_washer_m_btu + Double + false + + + end_use_electricity_clothes_dryer_m_btu + end_use_electricity_clothes_dryer_m_btu + end_use_electricity_clothes_dryer_m_btu + Double + false + + + end_use_electricity_range_oven_m_btu + end_use_electricity_range_oven_m_btu + end_use_electricity_range_oven_m_btu + Double + false + + + end_use_electricity_ceiling_fan_m_btu + end_use_electricity_ceiling_fan_m_btu + end_use_electricity_ceiling_fan_m_btu + Double + false + + + end_use_electricity_television_m_btu + end_use_electricity_television_m_btu + end_use_electricity_television_m_btu + Double + false + + + end_use_electricity_plug_loads_m_btu + end_use_electricity_plug_loads_m_btu + end_use_electricity_plug_loads_m_btu + Double + false + + + end_use_electricity_electric_vehicle_charging_m_btu + end_use_electricity_electric_vehicle_charging_m_btu + end_use_electricity_electric_vehicle_charging_m_btu + Double + false + + + end_use_electricity_well_pump_m_btu + end_use_electricity_well_pump_m_btu + end_use_electricity_well_pump_m_btu + Double + false + + + end_use_electricity_pool_heater_m_btu + end_use_electricity_pool_heater_m_btu + end_use_electricity_pool_heater_m_btu + Double + false + + + end_use_electricity_pool_pump_m_btu + end_use_electricity_pool_pump_m_btu + end_use_electricity_pool_pump_m_btu + Double + false + + + end_use_electricity_permanent_spa_heater_m_btu + end_use_electricity_permanent_spa_heater_m_btu + end_use_electricity_permanent_spa_heater_m_btu + Double + false + + + end_use_electricity_permanent_spa_pump_m_btu + end_use_electricity_permanent_spa_pump_m_btu + end_use_electricity_permanent_spa_pump_m_btu + Double + false + + + end_use_electricity_pv_m_btu + end_use_electricity_pv_m_btu + end_use_electricity_pv_m_btu + Double + false + + + end_use_electricity_generator_m_btu + end_use_electricity_generator_m_btu + end_use_electricity_generator_m_btu + Double + false + + + end_use_electricity_battery_m_btu + end_use_electricity_battery_m_btu + end_use_electricity_battery_m_btu + Double + false + + + end_use_natural_gas_heating_m_btu + end_use_natural_gas_heating_m_btu + end_use_natural_gas_heating_m_btu + Double + false + + + end_use_natural_gas_heating_heat_pump_backup_m_btu + end_use_natural_gas_heating_heat_pump_backup_m_btu + end_use_natural_gas_heating_heat_pump_backup_m_btu + Double + false + + + end_use_natural_gas_hot_water_m_btu + end_use_natural_gas_hot_water_m_btu + end_use_natural_gas_hot_water_m_btu + Double + false + + + end_use_natural_gas_clothes_dryer_m_btu + end_use_natural_gas_clothes_dryer_m_btu + end_use_natural_gas_clothes_dryer_m_btu + Double + false + + + end_use_natural_gas_range_oven_m_btu + end_use_natural_gas_range_oven_m_btu + end_use_natural_gas_range_oven_m_btu + Double + false + + + end_use_natural_gas_mech_vent_preheating_m_btu + end_use_natural_gas_mech_vent_preheating_m_btu + end_use_natural_gas_mech_vent_preheating_m_btu + Double + false + + + end_use_natural_gas_pool_heater_m_btu + end_use_natural_gas_pool_heater_m_btu + end_use_natural_gas_pool_heater_m_btu + Double + false + + + end_use_natural_gas_permanent_spa_heater_m_btu + end_use_natural_gas_permanent_spa_heater_m_btu + end_use_natural_gas_permanent_spa_heater_m_btu + Double + false + + + end_use_natural_gas_grill_m_btu + end_use_natural_gas_grill_m_btu + end_use_natural_gas_grill_m_btu + Double + false + + + end_use_natural_gas_lighting_m_btu + end_use_natural_gas_lighting_m_btu + end_use_natural_gas_lighting_m_btu + Double + false + + + end_use_natural_gas_fireplace_m_btu + end_use_natural_gas_fireplace_m_btu + end_use_natural_gas_fireplace_m_btu + Double + false + + + end_use_natural_gas_generator_m_btu + end_use_natural_gas_generator_m_btu + end_use_natural_gas_generator_m_btu + Double + false + + + end_use_fuel_oil_heating_m_btu + end_use_fuel_oil_heating_m_btu + end_use_fuel_oil_heating_m_btu + Double + false + + + end_use_fuel_oil_heating_heat_pump_backup_m_btu + end_use_fuel_oil_heating_heat_pump_backup_m_btu + end_use_fuel_oil_heating_heat_pump_backup_m_btu + Double + false + + + end_use_fuel_oil_hot_water_m_btu + end_use_fuel_oil_hot_water_m_btu + end_use_fuel_oil_hot_water_m_btu + Double + false + + + end_use_fuel_oil_clothes_dryer_m_btu + end_use_fuel_oil_clothes_dryer_m_btu + end_use_fuel_oil_clothes_dryer_m_btu + Double + false + + + end_use_fuel_oil_range_oven_m_btu + end_use_fuel_oil_range_oven_m_btu + end_use_fuel_oil_range_oven_m_btu + Double + false + + + end_use_fuel_oil_mech_vent_preheating_m_btu + end_use_fuel_oil_mech_vent_preheating_m_btu + end_use_fuel_oil_mech_vent_preheating_m_btu + Double + false + + + end_use_fuel_oil_grill_m_btu + end_use_fuel_oil_grill_m_btu + end_use_fuel_oil_grill_m_btu + Double + false + + + end_use_fuel_oil_lighting_m_btu + end_use_fuel_oil_lighting_m_btu + end_use_fuel_oil_lighting_m_btu + Double + false + + + end_use_fuel_oil_fireplace_m_btu + end_use_fuel_oil_fireplace_m_btu + end_use_fuel_oil_fireplace_m_btu + Double + false + + + end_use_fuel_oil_generator_m_btu + end_use_fuel_oil_generator_m_btu + end_use_fuel_oil_generator_m_btu + Double + false + + + end_use_propane_heating_m_btu + end_use_propane_heating_m_btu + end_use_propane_heating_m_btu + Double + false + + + end_use_propane_heating_heat_pump_backup_m_btu + end_use_propane_heating_heat_pump_backup_m_btu + end_use_propane_heating_heat_pump_backup_m_btu + Double + false + + + end_use_propane_hot_water_m_btu + end_use_propane_hot_water_m_btu + end_use_propane_hot_water_m_btu + Double + false + + + end_use_propane_clothes_dryer_m_btu + end_use_propane_clothes_dryer_m_btu + end_use_propane_clothes_dryer_m_btu + Double + false + + + end_use_propane_range_oven_m_btu + end_use_propane_range_oven_m_btu + end_use_propane_range_oven_m_btu + Double + false + + + end_use_propane_mech_vent_preheating_m_btu + end_use_propane_mech_vent_preheating_m_btu + end_use_propane_mech_vent_preheating_m_btu + Double + false + + + end_use_propane_grill_m_btu + end_use_propane_grill_m_btu + end_use_propane_grill_m_btu + Double + false + + + end_use_propane_lighting_m_btu + end_use_propane_lighting_m_btu + end_use_propane_lighting_m_btu + Double + false + + + end_use_propane_fireplace_m_btu + end_use_propane_fireplace_m_btu + end_use_propane_fireplace_m_btu + Double + false + + + end_use_propane_generator_m_btu + end_use_propane_generator_m_btu + end_use_propane_generator_m_btu + Double + false + + + end_use_wood_cord_heating_m_btu + end_use_wood_cord_heating_m_btu + end_use_wood_cord_heating_m_btu + Double + false + + + end_use_wood_cord_heating_heat_pump_backup_m_btu + end_use_wood_cord_heating_heat_pump_backup_m_btu + end_use_wood_cord_heating_heat_pump_backup_m_btu + Double + false + + + end_use_wood_cord_hot_water_m_btu + end_use_wood_cord_hot_water_m_btu + end_use_wood_cord_hot_water_m_btu + Double + false + + + end_use_wood_cord_clothes_dryer_m_btu + end_use_wood_cord_clothes_dryer_m_btu + end_use_wood_cord_clothes_dryer_m_btu + Double + false + + + end_use_wood_cord_range_oven_m_btu + end_use_wood_cord_range_oven_m_btu + end_use_wood_cord_range_oven_m_btu + Double + false + + + end_use_wood_cord_mech_vent_preheating_m_btu + end_use_wood_cord_mech_vent_preheating_m_btu + end_use_wood_cord_mech_vent_preheating_m_btu + Double + false + + + end_use_wood_cord_grill_m_btu + end_use_wood_cord_grill_m_btu + end_use_wood_cord_grill_m_btu + Double + false + + + end_use_wood_cord_lighting_m_btu + end_use_wood_cord_lighting_m_btu + end_use_wood_cord_lighting_m_btu + Double + false + + + end_use_wood_cord_fireplace_m_btu + end_use_wood_cord_fireplace_m_btu + end_use_wood_cord_fireplace_m_btu + Double + false + + + end_use_wood_cord_generator_m_btu + end_use_wood_cord_generator_m_btu + end_use_wood_cord_generator_m_btu + Double + false + + + end_use_wood_pellets_heating_m_btu + end_use_wood_pellets_heating_m_btu + end_use_wood_pellets_heating_m_btu + Double + false + + + end_use_wood_pellets_heating_heat_pump_backup_m_btu + end_use_wood_pellets_heating_heat_pump_backup_m_btu + end_use_wood_pellets_heating_heat_pump_backup_m_btu + Double + false + + + end_use_wood_pellets_hot_water_m_btu + end_use_wood_pellets_hot_water_m_btu + end_use_wood_pellets_hot_water_m_btu + Double + false + + + end_use_wood_pellets_clothes_dryer_m_btu + end_use_wood_pellets_clothes_dryer_m_btu + end_use_wood_pellets_clothes_dryer_m_btu + Double + false + + + end_use_wood_pellets_range_oven_m_btu + end_use_wood_pellets_range_oven_m_btu + end_use_wood_pellets_range_oven_m_btu + Double + false + + + end_use_wood_pellets_mech_vent_preheating_m_btu + end_use_wood_pellets_mech_vent_preheating_m_btu + end_use_wood_pellets_mech_vent_preheating_m_btu + Double + false + + + end_use_wood_pellets_grill_m_btu + end_use_wood_pellets_grill_m_btu + end_use_wood_pellets_grill_m_btu + Double + false + + + end_use_wood_pellets_lighting_m_btu + end_use_wood_pellets_lighting_m_btu + end_use_wood_pellets_lighting_m_btu + Double + false + + + end_use_wood_pellets_fireplace_m_btu + end_use_wood_pellets_fireplace_m_btu + end_use_wood_pellets_fireplace_m_btu + Double + false + + + end_use_wood_pellets_generator_m_btu + end_use_wood_pellets_generator_m_btu + end_use_wood_pellets_generator_m_btu + Double + false + + + end_use_coal_heating_m_btu + end_use_coal_heating_m_btu + end_use_coal_heating_m_btu + Double + false + + + end_use_coal_heating_heat_pump_backup_m_btu + end_use_coal_heating_heat_pump_backup_m_btu + end_use_coal_heating_heat_pump_backup_m_btu + Double + false + + + end_use_coal_hot_water_m_btu + end_use_coal_hot_water_m_btu + end_use_coal_hot_water_m_btu + Double + false + + + end_use_coal_clothes_dryer_m_btu + end_use_coal_clothes_dryer_m_btu + end_use_coal_clothes_dryer_m_btu + Double + false + + + end_use_coal_range_oven_m_btu + end_use_coal_range_oven_m_btu + end_use_coal_range_oven_m_btu + Double + false + + + end_use_coal_mech_vent_preheating_m_btu + end_use_coal_mech_vent_preheating_m_btu + end_use_coal_mech_vent_preheating_m_btu + Double + false + + + end_use_coal_grill_m_btu + end_use_coal_grill_m_btu + end_use_coal_grill_m_btu + Double + false + + + end_use_coal_lighting_m_btu + end_use_coal_lighting_m_btu + end_use_coal_lighting_m_btu + Double + false + + + end_use_coal_fireplace_m_btu + end_use_coal_fireplace_m_btu + end_use_coal_fireplace_m_btu + Double + false + + + end_use_coal_generator_m_btu + end_use_coal_generator_m_btu + end_use_coal_generator_m_btu + Double + false + + + load_heating_delivered_m_btu + load_heating_delivered_m_btu + load_heating_delivered_m_btu + Double + false + + + load_heating_heat_pump_backup_m_btu + load_heating_heat_pump_backup_m_btu + load_heating_heat_pump_backup_m_btu + Double + false + + + load_cooling_delivered_m_btu + load_cooling_delivered_m_btu + load_cooling_delivered_m_btu + Double + false + + + load_hot_water_delivered_m_btu + load_hot_water_delivered_m_btu + load_hot_water_delivered_m_btu + Double + false + + + load_hot_water_tank_losses_m_btu + load_hot_water_tank_losses_m_btu + load_hot_water_tank_losses_m_btu + Double + false + + + load_hot_water_desuperheater_m_btu + load_hot_water_desuperheater_m_btu + load_hot_water_desuperheater_m_btu + Double + false + + + load_hot_water_solar_thermal_m_btu + load_hot_water_solar_thermal_m_btu + load_hot_water_solar_thermal_m_btu + Double + false + + + unmet_hours_heating_hr + unmet_hours_heating_hr + unmet_hours_heating_hr + Double + false + + + unmet_hours_cooling_hr + unmet_hours_cooling_hr + unmet_hours_cooling_hr + Double + false + + + peak_electricity_winter_total_w + peak_electricity_winter_total_w + peak_electricity_winter_total_w + Double + false + + + peak_electricity_summer_total_w + peak_electricity_summer_total_w + peak_electricity_summer_total_w + Double + false + + + peak_electricity_annual_total_w + peak_electricity_annual_total_w + peak_electricity_annual_total_w + Double + false + + + peak_load_heating_delivered_k_btu_hr + peak_load_heating_delivered_k_btu_hr + peak_load_heating_delivered_k_btu_hr + Double + false + + + peak_load_cooling_delivered_k_btu_hr + peak_load_cooling_delivered_k_btu_hr + peak_load_cooling_delivered_k_btu_hr + Double + false + + + component_load_heating_roofs_m_btu + component_load_heating_roofs_m_btu + component_load_heating_roofs_m_btu + Double + false + + + component_load_heating_ceilings_m_btu + component_load_heating_ceilings_m_btu + component_load_heating_ceilings_m_btu + Double + false + + + component_load_heating_walls_m_btu + component_load_heating_walls_m_btu + component_load_heating_walls_m_btu + Double + false + + + component_load_heating_rim_joists_m_btu + component_load_heating_rim_joists_m_btu + component_load_heating_rim_joists_m_btu + Double + false + + + component_load_heating_foundation_walls_m_btu + component_load_heating_foundation_walls_m_btu + component_load_heating_foundation_walls_m_btu + Double + false + + + component_load_heating_doors_m_btu + component_load_heating_doors_m_btu + component_load_heating_doors_m_btu + Double + false + + + component_load_heating_windows_conduction_m_btu + component_load_heating_windows_conduction_m_btu + component_load_heating_windows_conduction_m_btu + Double + false + + + component_load_heating_windows_solar_m_btu + component_load_heating_windows_solar_m_btu + component_load_heating_windows_solar_m_btu + Double + false + + + component_load_heating_skylights_conduction_m_btu + component_load_heating_skylights_conduction_m_btu + component_load_heating_skylights_conduction_m_btu + Double + false + + + component_load_heating_skylights_solar_m_btu + component_load_heating_skylights_solar_m_btu + component_load_heating_skylights_solar_m_btu + Double + false + + + component_load_heating_floors_m_btu + component_load_heating_floors_m_btu + component_load_heating_floors_m_btu + Double + false + + + component_load_heating_slabs_m_btu + component_load_heating_slabs_m_btu + component_load_heating_slabs_m_btu + Double + false + + + component_load_heating_internal_mass_m_btu + component_load_heating_internal_mass_m_btu + component_load_heating_internal_mass_m_btu + Double + false + + + component_load_heating_infiltration_m_btu + component_load_heating_infiltration_m_btu + component_load_heating_infiltration_m_btu + Double + false + + + component_load_heating_natural_ventilation_m_btu + component_load_heating_natural_ventilation_m_btu + component_load_heating_natural_ventilation_m_btu + Double + false + + + component_load_heating_mechanical_ventilation_m_btu + component_load_heating_mechanical_ventilation_m_btu + component_load_heating_mechanical_ventilation_m_btu + Double + false + + + component_load_heating_whole_house_fan_m_btu + component_load_heating_whole_house_fan_m_btu + component_load_heating_whole_house_fan_m_btu + Double + false + + + component_load_heating_ducts_m_btu + component_load_heating_ducts_m_btu + component_load_heating_ducts_m_btu + Double + false + + + component_load_heating_internal_gains_m_btu + component_load_heating_internal_gains_m_btu + component_load_heating_internal_gains_m_btu + Double + false + + + component_load_heating_lighting_m_btu + component_load_heating_lighting_m_btu + component_load_heating_lighting_m_btu + Double + false + + + component_load_cooling_roofs_m_btu + component_load_cooling_roofs_m_btu + component_load_cooling_roofs_m_btu + Double + false + + + component_load_cooling_ceilings_m_btu + component_load_cooling_ceilings_m_btu + component_load_cooling_ceilings_m_btu + Double + false + + + component_load_cooling_walls_m_btu + component_load_cooling_walls_m_btu + component_load_cooling_walls_m_btu + Double + false + + + component_load_cooling_rim_joists_m_btu + component_load_cooling_rim_joists_m_btu + component_load_cooling_rim_joists_m_btu + Double + false + + + component_load_cooling_foundation_walls_m_btu + component_load_cooling_foundation_walls_m_btu + component_load_cooling_foundation_walls_m_btu + Double + false + + + component_load_cooling_doors_m_btu + component_load_cooling_doors_m_btu + component_load_cooling_doors_m_btu + Double + false + + + component_load_cooling_windows_conduction_m_btu + component_load_cooling_windows_conduction_m_btu + component_load_cooling_windows_conduction_m_btu + Double + false + + + component_load_cooling_windows_solar_m_btu + component_load_cooling_windows_solar_m_btu + component_load_cooling_windows_solar_m_btu + Double + false + + + component_load_cooling_skylights_conduction_m_btu + component_load_cooling_skylights_conduction_m_btu + component_load_cooling_skylights_conduction_m_btu + Double + false + + + component_load_cooling_skylights_solar_m_btu + component_load_cooling_skylights_solar_m_btu + component_load_cooling_skylights_solar_m_btu + Double + false + + + component_load_cooling_floors_m_btu + component_load_cooling_floors_m_btu + component_load_cooling_floors_m_btu + Double + false + + + component_load_cooling_slabs_m_btu + component_load_cooling_slabs_m_btu + component_load_cooling_slabs_m_btu + Double + false + + + component_load_cooling_internal_mass_m_btu + component_load_cooling_internal_mass_m_btu + component_load_cooling_internal_mass_m_btu + Double + false + + + component_load_cooling_infiltration_m_btu + component_load_cooling_infiltration_m_btu + component_load_cooling_infiltration_m_btu + Double + false + + + component_load_cooling_natural_ventilation_m_btu + component_load_cooling_natural_ventilation_m_btu + component_load_cooling_natural_ventilation_m_btu + Double + false + + + component_load_cooling_mechanical_ventilation_m_btu + component_load_cooling_mechanical_ventilation_m_btu + component_load_cooling_mechanical_ventilation_m_btu + Double + false + + + component_load_cooling_whole_house_fan_m_btu + component_load_cooling_whole_house_fan_m_btu + component_load_cooling_whole_house_fan_m_btu + Double + false + + + component_load_cooling_ducts_m_btu + component_load_cooling_ducts_m_btu + component_load_cooling_ducts_m_btu + Double + false + + + component_load_cooling_internal_gains_m_btu + component_load_cooling_internal_gains_m_btu + component_load_cooling_internal_gains_m_btu + Double + false + + + component_load_cooling_lighting_m_btu + component_load_cooling_lighting_m_btu + component_load_cooling_lighting_m_btu + Double + false + + + hot_water_clothes_washer_gal + hot_water_clothes_washer_gal + hot_water_clothes_washer_gal + Double + false + + + hot_water_dishwasher_gal + hot_water_dishwasher_gal + hot_water_dishwasher_gal + Double + false + + + hot_water_fixtures_gal + hot_water_fixtures_gal + hot_water_fixtures_gal + Double + false + + + hot_water_distribution_waste_gal + hot_water_distribution_waste_gal + hot_water_distribution_waste_gal + Double + false + + + resilience_battery_hr + resilience_battery_hr + resilience_battery_hr + Double + false + + + + + Reporting.QAQC + + + + Measure Type + ReportingMeasure + string + + + Intended Software Tool + OpenStudio Application + string + + + Intended Software Tool + Parametric Analysis Tool + string + + + + + README.md + md + readme + CDB2D617 + + + README.md.erb + erb + readmeerb + 513F28E9 + + + + OpenStudio + 2.9.1 + 2.9.1 + + measure.rb + rb + script + 706986B2 + + + test_report_sim_output.rb + rb + test + E54EAD68 + + + diff --git a/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportUtilityBills/measure.xml b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportUtilityBills/measure.xml new file mode 100644 index 00000000..4b508cd5 --- /dev/null +++ b/buildstockbatch/test/test_inputs/test_openstudio_buildstock/resources/hpxml-measures/ReportUtilityBills/measure.xml @@ -0,0 +1,354 @@ + + + 3.1 + report_utility_bills + ca88a425-e59a-4bc4-af51-c7e7d1e960fe + 7a771c54-4bba-4a64-bbc3-230311117b0e + 2024-06-24T16:04:41Z + 15BF4E57 + ReportUtilityBills + Utility Bills Report + Calculates and reports utility bills for residential HPXML-based models. + Calculate electric/gas utility bills based on monthly fixed charges and marginal rates. Calculate other utility bills based on marginal rates for oil, propane, wood cord, wood pellets, and coal. User can specify PV compensation types of 'Net-Metering' or 'Feed-In Tariff', along with corresponding rates and connection fees. + + + output_format + Output Format + The file format of the annual (and timeseries, if requested) outputs. + Choice + false + false + csv + + + csv + csv + + + json + json + + + msgpack + msgpack + + + + + include_annual_bills + Generate Annual Utility Bills + Generates output file containing annual utility bills. + Boolean + false + false + true + + + true + true + + + false + false + + + + + include_monthly_bills + Generate Monthly Utility Bills + Generates output file containing monthly utility bills. + Boolean + false + false + true + + + true + true + + + false + false + + + + + monthly_timestamp_convention + Generate Monthly Output: Timestamp Convention + Determines whether monthly timestamps use the start-of-period or end-of-period convention. + Choice + false + false + start + + + start + start + + + end + end + + + + + annual_output_file_name + Annual Output File Name + If not provided, defaults to 'results_bills.csv' (or 'results_bills.json' or 'results_bills.msgpack'). + String + false + false + + + monthly_output_file_name + Monthly Output File Name + If not provided, defaults to 'results_bills_monthly.csv' (or 'results_bills_monthly.json' or 'results_bills_monthly.msgpack'). + String + false + false + + + register_annual_bills + Register Annual Utility Bills + Registers annual utility bills with the OpenStudio runner for downstream processing. + Boolean + false + false + true + + + true + true + + + false + false + + + + + register_monthly_bills + Register Monthly Utility Bills + Registers monthly utility bills with the OpenStudio runner for downstream processing. + Boolean + false + false + false + + + true + true + + + false + false + + + + + + + + Reporting.QAQC + + + + Measure Type + ReportingMeasure + string + + + + + README.md + md + readme + 13D965BE + + + README.md.erb + erb + readmeerb + 513F28E9 + + + + OpenStudio + 3.3.0 + 3.3.0 + + measure.rb + rb + script + C0D15021 + + + detailed_rates/Sample Flat Rate Min Annual Charge.json + json + resource + 453ED6BD + + + detailed_rates/Sample Flat Rate Min Monthly Charge.json + json + resource + A39362E3 + + + detailed_rates/Sample Flat Rate.json + json + resource + C0FCBE3B + + + detailed_rates/Sample Real-Time Pricing Rate Min Annual Charge.json + json + resource + 12C12981 + + + detailed_rates/Sample Real-Time Pricing Rate Min Monthly Charge.json + json + resource + DE28BDA1 + + + detailed_rates/Sample Real-Time Pricing Rate.json + json + resource + 40D684ED + + + detailed_rates/Sample Tiered Rate Min Annual Charge.json + json + resource + 05C5F7BD + + + detailed_rates/Sample Tiered Rate Min Monthly Charge.json + json + resource + 9177D651 + + + detailed_rates/Sample Tiered Rate.json + json + resource + 27936FC1 + + + detailed_rates/Sample Tiered Time-of-Use Rate Min Annual Charge.json + json + resource + E59E9AEE + + + detailed_rates/Sample Tiered Time-of-Use Rate Min Monthly Charge.json + json + resource + 75AD92DF + + + detailed_rates/Sample Tiered Time-of-Use Rate.json + json + resource + 4508028D + + + detailed_rates/Sample Time-of-Use Rate High Peak.json + json + resource + 1F5FA05C + + + detailed_rates/Sample Time-of-Use Rate Min Annual Charge.json + json + resource + 2CC2386E + + + detailed_rates/Sample Time-of-Use Rate Min Monthly Charge.json + json + resource + 387337AD + + + detailed_rates/Sample Time-of-Use Rate.json + json + resource + AD93D08A + + + detailed_rates/openei_rates.zip + zip + resource + 56DDA6EC + + + simple_rates/HouseholdConsumption.csv + csv + resource + 0BEECB93 + + + simple_rates/README.md + md + resource + C7E1E1CB + + + simple_rates/pr_all_update.csv + csv + resource + CF6409BD + + + util.rb + rb + resource + 07D547F6 + + + Contains Demand Charges.json + json + test + 31A7BE3B + + + Detailed Rate.json + json + test + 953EE2AC + + + Invalid Fixed Charge Units.json + json + test + 6CDC3F13 + + + Invalid Min Charge Units.json + json + test + 32FB5BA8 + + + Missing Required Fields.json + json + test + 3DCED656 + + + data.csv + csv + test + F96CB80F + + + test_report_utility_bills.rb + rb + test + 7B65C730 + + +