Merge pull request #1109 from NREL/detailed-bill-calcs

Calculate detailed utility bills

.github/workflows/config.yml

@@ -177,13 +177,6 @@ jobs:
           pip install plotly
           python test/process_bsb_analysis.py
 
-      - name: Run tests
-        run: |
-          sudo gem install minitest-reporters
-          sudo gem install simplecov
-          sudo gem install simplecov-html
-          ruby test/test_bsb_analysis.rb
-
       - name: Upload integration results
         uses: actions/upload-artifact@v3
         with:
@@ -202,6 +195,13 @@ jobs:
             project_testing/testing_upgrades/results_csvs/results_up16.csv
           name: buildstockbatch_results_csvs
 
+      - name: Run tests
+        run: |
+          sudo gem install minitest-reporters
+          sudo gem install simplecov
+          sudo gem install simplecov-html
+          ruby test/test_bsb_analysis.rb
+
   compare-tools:
     runs-on: ubuntu-latest
     needs: [analysis-tests, integration-tests]

CHANGELOG.md

@@ -9,6 +9,7 @@ Features
 - Update `run_analysis.rb` to map datapoints to run folder names when the `-k` argument is supplied ([#1138](https://github.com/NREL/resstock/pull/1138))
 - Add Water Heater Location and Geometry Space Combination, update Geometry Garage and Geometry Floor Area Bin to RECS2020, update RECS2020 microdata from v2 to v4, auto-generate buildstocks for yml_precomputed tests ([#1125](https://github.com/NREL/resstock/pull/1125))
 - Add ability to request timeseries resilience output from the yml file ([#1113](https://github.com/NREL/resstock/pull/1113))
+- Add ability to calculate detailed utility bills based on a user-specified TSV file of paths to JSON utility rate tariff files ([#1109](https://github.com/NREL/resstock/pull/1109))
 
 Fixes
 - Set standard format for options_lookup ([#962](https://github.com/NREL/resstock/pull/962))

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

@@ -23,6 +23,8 @@ build_existing_model.simulation_control_run_period_calendar_year,"This numeric f
 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."

measures/ApplyUpgrade/measure.rb

@@ -430,6 +430,7 @@ def run(model, runner, user_arguments)
 
     # Utility Bills
     measures['BuildResidentialHPXML'][0]['utility_bill_scenario_names'] = values['utility_bill_scenario_names']
+    measures['BuildResidentialHPXML'][0]['utility_bill_electricity_filepaths'] = values['utility_bill_electricity_filepaths']
     measures['BuildResidentialHPXML'][0]['utility_bill_electricity_fixed_charges'] = values['utility_bill_electricity_fixed_charges']
     measures['BuildResidentialHPXML'][0]['utility_bill_electricity_marginal_rates'] = values['utility_bill_electricity_marginal_rates']
     measures['BuildResidentialHPXML'][0]['utility_bill_natural_gas_fixed_charges'] = values['utility_bill_natural_gas_fixed_charges']

measures/ApplyUpgrade/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>apply_upgrade</name>
   <uid>33f1654c-f734-43d1-b35d-9d2856e41b5a</uid>
-  <version_id>1e261f14-26dd-4944-9bbf-a667008cef74</version_id>
-  <version_modified>2023-10-10T21:15:01Z</version_modified>
+  <version_id>f3532e90-9cb3-44bb-adb9-51ac90998028</version_id>
+  <version_modified>2023-10-24T01:53:02Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>ApplyUpgrade</class_name>
   <display_name>Apply Upgrade</display_name>
@@ -6330,7 +6330,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>FDFA2666</checksum>
+      <checksum>03C861F4</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>