Merge pull request #1076 from NREL/latest-os-hpxml2-os361

Latest OS-HPXML, OS v3.6.1

.github/workflows/config.yml

@@ -11,7 +11,7 @@ jobs:
   unit-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.5.1
+      image: docker://nrel/openstudio:3.6.1
     steps:
       - uses: actions/checkout@v3
         with:
@@ -48,7 +48,7 @@ jobs:
   analysis-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.5.1
+      image: docker://nrel/openstudio:3.6.1
     steps:
       - uses: actions/checkout@v3
         with:
@@ -79,15 +79,22 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
 
+      - name: Download and Install OpenStudio
+        run: |
+          wget -q https://github.com/NREL/OpenStudio/releases/download/v3.6.1/OpenStudio-3.6.1+bb9481519e-Ubuntu-20.04-x86_64.deb
+          sudo apt install -y ./OpenStudio-3.6.1+bb9481519e-Ubuntu-20.04-x86_64.deb
+          openstudio openstudio_version
+          which openstudio
+
       - name: Run buildstockbatch
         run: |
-          pip install git+https://github.com/NREL/buildstockbatch.git@v2023.01.0
+          pip install git+https://github.com/NREL/buildstockbatch.git@v2023.05.0
           
-          buildstock_docker project_national/national_baseline.yml
-          buildstock_docker project_testing/testing_baseline.yml
+          buildstock_local project_national/national_baseline.yml
+          buildstock_local project_testing/testing_baseline.yml
           
-          buildstock_docker project_national/national_upgrades.yml
-          buildstock_docker project_testing/testing_upgrades.yml
+          buildstock_local project_national/national_upgrades.yml
+          buildstock_local project_testing/testing_upgrades.yml
 
       - name: Unzip results
         run: |

CHANGELOG.md

@@ -8,6 +8,8 @@ Features
 - Add descriptions to the housing characteristics ([#1069](https://github.com/NREL/resstock/pull/1069))
 - Connect ASHP to optional capacity retention temperature and fraction arguments (that already exist for MSHP) ([#1071](https://github.com/NREL/resstock/pull/1071))
 - Add data dictionary files for describing various outputs. Use these files to (1) check against integration test results, and (2) generate documentation tables ([#1058](https://github.com/NREL/resstock/pull/1058))
+- OS-HPXML now supports use of optional heat pump capacity retention temperature and fraction arguments (applicable to both ASHP and MSHP) ([#1072](https://github.com/NREL/resstock/pull/1072))
+- Update to OpenStudio v3.6.1 ([#1076](https://github.com/NREL/resstock/pull/1076))
 
 Fixes
 - Pulls in upstream OS-HPXML fix related to [avoiding possible OpenStudio temporary directory collision](https://github.com/NREL/OpenStudio-HPXML/pull/1316) causing random errors ([#1054](https://github.com/NREL/resstock/pull/1054))
@@ -45,7 +47,7 @@ Fixes
 - Rename sources subfolders so all tsv_makers can be imported as packages ([#959](https://github.com/NREL/resstock/pull/959))
 - Fix heating and cooling auto-season inputs ([#975](https://github.com/NREL/resstock/pull/975))
 - Remove Void from dependency columns in TSVs and update tests.([#981](https://github.com/NREL/resstock/pull/981))
-- Update low-sample downscaling logic to use raw source_weight, which leads to minor changes to Geometry Floor Area and HVAC Partial Sapce Conditioning ([#982](https://github.com/NREL/resstock/pull/982))
+- Update low-sample downscaling logic to use raw source_weight, which leads to minor changes to Geometry Floor Area and HVAC Partial Space Conditioning ([#982](https://github.com/NREL/resstock/pull/982))
 
 ## ResStock v2.5.0
 ###### February 9, 2022 - [Diff](https://github.com/NREL/OpenStudio-BuildStock/compare/v2.4.0...v2.5.0)

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

@@ -23,6 +23,7 @@ report_simulation_output.emissions_<type>_<scenario_name>_electricity_freezer_lb
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_generator_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Generator,emissions__<type>__<scenario_name>__electricity__generator__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_heating_fans_pumps_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Heating Fans/Pumps,emissions__<type>__<scenario_name>__electricity__heating_fans_pumps__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_heating_heat_pump_backup_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Heating Heat Pump Backup,emissions__<type>__<scenario_name>__electricity__heating_heat_pump_backup__lb,lb,Scenario emissions for this Electricity end use only
+report_simulation_output.emissions_<type>_<scenario_name>_electricity_heating_heat_pump_backup_fans_pumps_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Heating Heat Pump Backup Fans/Pumps,emissions__<type>__<scenario_name>__electricity__heating_heat_pump_backup_fans_pumps__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_heating_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Heating,emissions__<type>__<scenario_name>__electricity__heating__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_hot_tub_heater_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Hot Tub Heater,emissions__<type>__<scenario_name>__electricity__hot_tub_heater__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_hot_tub_pump_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Hot Tub Pump,emissions__<type>__<scenario_name>__electricity__hot_tub_pump__lb,lb,Scenario emissions for this Electricity end use only
@@ -35,14 +36,15 @@ report_simulation_output.emissions_<type>_<scenario_name>_electricity_lighting_i
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_mech_vent_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Mech Vent,emissions__<type>__<scenario_name>__electricity__mech_vent__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_mech_vent_precooling_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Mech Vent Precooling,emissions__<type>__<scenario_name>__electricity__mech_vent_precooling__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_mech_vent_preheating_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Mech Vent Preheating,emissions__<type>__<scenario_name>__electricity__mech_vent_preheating__lb,lb,Scenario emissions for this Electricity end use only
+report_simulation_output.emissions_<type>_<scenario_name>_electricity_net_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Net,emissions__<type>__<scenario_name>__electricity__net__lb,lb,Subtracts any power produced by PV or generators
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_plug_loads_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Plug Loads,emissions__<type>__<scenario_name>__electricity__plug_loads__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_pool_heater_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Pool Heater,emissions__<type>__<scenario_name>__electricity__pool_heater__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_pool_pump_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Pool Pump,emissions__<type>__<scenario_name>__electricity__pool_pump__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_pv_lb,lb,Emissions: <type>: <scenario_name>: Electricity: PV,emissions__<type>__<scenario_name>__electricity__pv__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_range_oven_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Range/Oven,emissions__<type>__<scenario_name>__electricity__range_oven__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_refrigerator_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Refrigerator,emissions__<type>__<scenario_name>__electricity__refrigerator__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_television_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Television,emissions__<type>__<scenario_name>__electricity__television__lb,lb,Scenario emissions for this Electricity end use only
-report_simulation_output.emissions_<type>_<scenario_name>_electricity_total_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Total,emissions__<type>__<scenario_name>__electricity__total__lb,lb,Scenario emissions for Electricity only
+report_simulation_output.emissions_<type>_<scenario_name>_electricity_total_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Total,emissions__<type>__<scenario_name>__electricity__total__lb,lb,"Scenario total emissions for Electricity only, includes any battery charging/discharging"
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_well_pump_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Well Pump,emissions__<type>__<scenario_name>__electricity__well_pump__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_electricity_whole_house_fan_lb,lb,Emissions: <type>: <scenario_name>: Electricity: Whole House Fan,emissions__<type>__<scenario_name>__electricity__whole_house_fan__lb,lb,Scenario emissions for this Electricity end use only
 report_simulation_output.emissions_<type>_<scenario_name>_fuel_oil_clothes_dryer_lb,lb,Emissions: <type>: <scenario_name>: Fuel Oil: Clothes Dryer,emissions__<type>__<scenario_name>__fuel_oil__clothes_dryer__lb,lb,Scenario emissions for this Fuel Oil end use only
@@ -69,6 +71,7 @@ report_simulation_output.emissions_<type>_<scenario_name>_natural_gas_mech_vent_
 report_simulation_output.emissions_<type>_<scenario_name>_natural_gas_pool_heater_lb,lb,Emissions: <type>: <scenario_name>: Natural Gas: Pool Heater,emissions__<type>__<scenario_name>__natural_gas__pool_heater__lb,lb,Scenario emissions for this Natural Gas end use only
 report_simulation_output.emissions_<type>_<scenario_name>_natural_gas_range_oven_lb,lb,Emissions: <type>: <scenario_name>: Natural Gas: Range/Oven,emissions__<type>__<scenario_name>__natural_gas__range_oven__lb,lb,Scenario emissions for this Natural Gas end use only
 report_simulation_output.emissions_<type>_<scenario_name>_natural_gas_total_lb,lb,Emissions: <type>: <scenario_name>: Natural Gas: Total,emissions__<type>__<scenario_name>__natural_gas__total__lb,lb,Scenario emissions for Natural Gas only
+report_simulation_output.emissions_<type>_<scenario_name>_net_lb,lb,Emissions: <type>: <scenario_name>: Net,emissions__<type>__<scenario_name>__net__lb,lb,Subtracts any power produced by PV or generators
 report_simulation_output.emissions_<type>_<scenario_name>_propane_clothes_dryer_lb,lb,Emissions: <type>: <scenario_name>: Propane: Clothes Dryer,emissions__<type>__<scenario_name>__propane__clothes_dryer__lb,lb,Scenario emissions for this Propane end use only
 report_simulation_output.emissions_<type>_<scenario_name>_propane_fireplace_lb,lb,Emissions: <type>: <scenario_name>: Propane: Fireplace,emissions__<type>__<scenario_name>__propane__fireplace__lb,lb,Scenario emissions for this Propane end use only
 report_simulation_output.emissions_<type>_<scenario_name>_propane_generator_lb,lb,Emissions: <type>: <scenario_name>: Propane: Generator,emissions__<type>__<scenario_name>__propane__generator__lb,lb,Scenario emissions for this Propane end use only
@@ -80,7 +83,7 @@ report_simulation_output.emissions_<type>_<scenario_name>_propane_lighting_lb,lb
 report_simulation_output.emissions_<type>_<scenario_name>_propane_mech_vent_preheating_lb,lb,Emissions: <type>: <scenario_name>: Propane: Mech Vent Preheating,emissions__<type>__<scenario_name>__propane__mech_vent_preheating__lb,lb,Scenario emissions for this Propane end use only
 report_simulation_output.emissions_<type>_<scenario_name>_propane_range_oven_lb,lb,Emissions: <type>: <scenario_name>: Propane: Range/Oven,emissions__<type>__<scenario_name>__propane__range_oven__lb,lb,Scenario emissions for this Propane end use only
 report_simulation_output.emissions_<type>_<scenario_name>_propane_total_lb,lb,Emissions: <type>: <scenario_name>: Propane: Total,emissions__<type>__<scenario_name>__propane__total__lb,lb,Scenario emissions for Propane only
-report_simulation_output.emissions_<type>_<scenario_name>_total_lb,lb,Emissions: <type>: <scenario_name>: Total,emissions__<type>__<scenario_name>__total__lb,lb,Scenario total emissions
+report_simulation_output.emissions_<type>_<scenario_name>_total_lb,lb,Emissions: <type>: <scenario_name>: Total,emissions__<type>__<scenario_name>__total__lb,lb,"Scenario total emissions, includes any battery charging/discharging"
 report_simulation_output.emissions_<type>_<scenario_name>_wood_cord_clothes_dryer_lb,lb,Emissions: <type>: <scenario_name>: Wood Cord: Clothes Dryer,emissions__<type>__<scenario_name>__wood_cord__clothes_dryer__lb,lb,Scenario emissions for this Wood Cord end use only
 report_simulation_output.emissions_<type>_<scenario_name>_wood_cord_fireplace_lb,lb,Emissions: <type>: <scenario_name>: Wood Cord: Fireplace,emissions__<type>__<scenario_name>__wood_cord__fireplace__lb,lb,Scenario emissions for this Wood Cord end use only
 report_simulation_output.emissions_<type>_<scenario_name>_wood_cord_generator_lb,lb,Emissions: <type>: <scenario_name>: Wood Cord: Generator,emissions__<type>__<scenario_name>__wood_cord__generator__lb,lb,Scenario emissions for this Wood Cord end use only

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

@@ -49,9 +49,24 @@ apply_upgrade.reference_scenario,The upgrade_name which should act as a referenc
 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_timeseries_total_consumptions,Generates timeseries energy consumptions for building total.
+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_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.