Merge branch 'develop' into rajeee-floor-area-patch

.github/workflows/config.yml

@@ -281,37 +281,25 @@ jobs:
  pip install plotly
  pip install kaleido
  
- mkdir test/base_results/comparisons
- 
- mkdir test/base_results/comparisons/baseline
- 
- mkdir test/base_results/comparisons/baseline/annual
- 
- python test/compare.py -a samples -b base_results/baseline/annual -f samples -e test/base_results/comparisons/baseline/annual
- 
- python test/compare.py -a results -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual
- python test/compare.py -a results -af sum -ac build_existing_model.geometry_building_type_recs -x results_output_building_type_sum.csv -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual
- 
- python test/compare.py -a visualize -dc build_existing_model.geometry_building_type_recs -x results_output_building_type.html -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual
- # python test/compare.py -a visualize -dc build_existing_model.geometry_foundation_type -x results_output_foundation_type.html -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual
- # python test/compare.py -a visualize -dc build_existing_model.census_region -x results_output_cr.html -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual
- # python test/compare.py -a visualize -dc build_existing_model.geometry_building_type_recs -ac build_existing_model.census_region -af sum -x results_output_cr_sum.html -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual
+ # baseline annual
+ mkdir -p test/base_results/comparisons/baseline/annual
+ python test/compare.py -a samples -b base_results/baseline/annual -f samples -e test/base_results/comparisons/baseline/annual # base_samples.csv, feature_samples.csv
+ python test/compare.py -a results -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual # results_characteristics.csv, results_output.csv
+ python test/compare.py -a results -af sum -ac build_existing_model.geometry_building_type_recs -x results_output_building_type_sum.csv -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual # results_output_building_type_sum.csv
+ python test/compare.py -a visualize -dc build_existing_model.geometry_building_type_recs -x results_output_building_type.html -b base_results/baseline/annual -f results/baseline/annual -e test/base_results/comparisons/baseline/annual # *.html
  
+ # baseline timeseries
  mkdir test/base_results/comparisons/baseline/timeseries
- 
- python test/compare.py -a timeseries -b base_results/baseline/timeseries -f results/baseline/timeseries -e test/base_results/comparisons/baseline/timeseries
- 
- mkdir test/base_results/comparisons/upgrades
- 
- mkdir test/base_results/comparisons/upgrades/annual
- 
- python test/compare.py -a results -b base_results/upgrades/annual -f results/upgrades/annual -e test/base_results/comparisons/upgrades/annual
+ python test/compare.py -a timeseries -b base_results/baseline/timeseries -f results/baseline/timeseries -e test/base_results/comparisons/baseline/timeseries # cvrmse_nmbe_*.csv
  
- python test/compare.py -a visualize -x results_output.html -b base_results/upgrades/annual -f results/upgrades/annual -e test/base_results/comparisons/upgrades/annual
+ # upgrades annual
+ mkdir -p test/base_results/comparisons/upgrades/annual
+ python test/compare.py -a results -b base_results/upgrades/annual -f results/upgrades/annual -e test/base_results/comparisons/upgrades/annual # results_output.csv
+ python test/compare.py -a visualize -x results_output.html -b base_results/upgrades/annual -f results/upgrades/annual -e test/base_results/comparisons/upgrades/annual # *.html
  
+ # upgrades timeseries
  mkdir test/base_results/comparisons/upgrades/timeseries
- 
- python test/compare.py -a timeseries -b base_results/upgrades/timeseries -f results/upgrades/timeseries -e test/base_results/comparisons/upgrades/timeseries
+ python test/compare.py -a timeseries -b base_results/upgrades/timeseries -f results/upgrades/timeseries -e test/base_results/comparisons/upgrades/timeseries # cvrmse_nmbe_*.csv
 
  - name: Upload comparisons
  uses: actions/upload-artifact@v4

README.md

@@ -18,5 +18,5 @@ This repository contains:
 
 Software for running ResStock simulations:
 
- - [Versions 2.3.0](https://github.com/NREL/resstock/releases/tag/v2.3.0) and later only support the use of [buildstockbatch](https://github.com/NREL/buildstockbatch) for deploying simulations on high-performance or cloud computing. Version 2.3.0 also removed separate projects for single-family detached and multifamily buildings, in lieu of a combined `project_national` representing the U.S. residential building stock. See the [changelog](https://github.com/NREL/resstock/blob/main/CHANGELOG.md) for more details.
+ - [Versions 2.3.0](https://github.com/NREL/resstock/releases/tag/v2.3.0) and later only support the use of [buildstockbatch](https://github.com/NREL/buildstockbatch) for deploying simulations on high-performance or cloud computing. Version 2.3.0 also removed separate projects for single-family detached and multifamily buildings, in lieu of a combined `project_national` representing the U.S. residential building stock. See the [changelogs](https://resstock.readthedocs.io/en/latest/changelog/index.html) for more details.
  - For large-scale production runs of ResStock, it is recommended that buildstockbatch is used. For smaller-scale tests, [`run_analysis.rb`](https://github.com/NREL/resstock/blob/develop/workflow/run_analysis.rb) can be used. Information about the workflow can be found in ResStock's [documentation](https://resstock.readthedocs.io/en/latest/basic_tutorial/run_project.html#using-run-analysis-rb).

docs/read_the_docs/source/changelog/changelog_dev.rst

@@ -5,3 +5,98 @@ Development Changelog
 .. changelog::
  :version: v3.4.0
  :released: pending
+
+ .. change::
+
+ :tags: bugfix, characteristics
+ :pullreq: 1265
+ :tickets: 1236
+
+ **Date**: 2024-08-06
+
+ Title:
+ Fix Hot Water Fixtures multipliers
+
+ Description:
+ Mean-shift hot water usage multipliers distribution by increasing weighted average from 0.8 to 1.0 in Hot Water Fixtures.tsv.
+
+ Assignees: Lixi Liu
+
+ :tags: workflow, infiltration, bugfix
+ :pullreq: 1257
+
+ **Date**: 2024-08-20
+
+ Title:
+ Air leakage type "unit total"
+
+ Description:
+ Update options_lookup and ResStockArguments to use "unit total" air leakage type instead of the current "unit exterior only" type w/ infiltration adjustment approach.
+ Modeled infiltration for dwelling units now have an upper bound equal to the sampled ACH50 option.
+ Update BuildExistingModel to register adjusted total infiltration ACH50 value.
+
+ Assignees: Joe Robertson
+
+ .. change::
+ :tags: characteristics, floor area, bugfix
+ :pullreq: 1301
+
+ **Date**: 2024-09-18
+
+ Title:
+ Fix RECS floor area bins
+
+ Description:
+ RECS have been using incorrect floor area bins when assigning some characteristics due to a bug on how floor area bin is calculated. This PR fixes the issue.
+
+ Assignees: Rajendra Adhikari, Anthony Fontanini
+
+ .. change::
+ :tags: workflow, hot water, feature
+ :pullreq: 1282
+
+ **Date**: 2024-09-04
+
+ Title:
+ Latest OS-HPXML
+
+ Description:
+ For hot water end uses OS-HPXML now directly uses equations from https://www.fsec.ucf.edu/en/publications/pdf/fsec-pf-464-15.pdf, that are a function of number of occupants, for operational calculations.
+
+ OpenStudio-HPXML: `pull request 1761 <https://github.com/NREL/OpenStudio-HPXML/pull/1761>`_
+
+ Assignees: Joe Robertson
+
+
+ .. change::
+ :tags: workflow, plug loads, feature
+ :pullreq: 1298
+
+ **Date**: 2024-09-24
+
+ Title:
+ Latest OS-HPXML
+
+ Description:
+ For TV plug loads, we are now using OS-HPXML defaults that directly use equations from RECS 2020 that are a function of number of occupants and conditioned floor area.
+ For operational calculations in general, we are also updating the relationships between number of bedrooms/occupants based on RECS 2020 and disaggregated by building types.
+
+ OpenStudio-HPXML: `pull request 1690 <https://github.com/NREL/OpenStudio-HPXML/pull/1690>`_, `pull request 1775 <https://github.com/NREL/OpenStudio-HPXML/pull/1775>`_
+
+ Assignees: Joe Robertson
+
+
+ .. change::
+ :tags: workflow, hvac, feature
+ :pullreq: 1254
+
+ **Date**: 2024-09-218
+
+ Title:
+ Heating and Cooling Unavailable Days
+
+ Description:
+ The purpose of this PR is to account for dwelling units whose HVAC system (heating/cooling) is unavailable for some number of days during the year (per RECS 2020).
+ Specifically, this PR modifies HVAC heating/cooling seasons using number of unavailable days and BAHSP definition for heating/cooling months.
+
+ Assignees: Joe Robertson