Merge pull request #1326 from NREL/3_4_0

Prep v3.4.0 release
NREL · Dec 2, 2024 · 0fbef2d · 0fbef2d
2 parents f88cb14 + 1337230
commit 0fbef2d
Show file tree

Hide file tree

Showing 4 changed files with 146 additions and 138 deletions.
diff --git a/docs/read_the_docs/source/changelog/changelog_3_4_0.rst b/docs/read_the_docs/source/changelog/changelog_3_4_0.rst
@@ -0,0 +1,143 @@
+================
+v3.4.0 Changelog
+================
+
+.. changelog::
+    :version: v3.4.0
+    :released: 2024-12-02
+
+    .. change::
+        :tags: software, openstudio, feature
+        :pullreq: 1318
+
+        **Date**: 2024-11-19
+
+        Title:
+        Latest OS-HPXML
+
+        Description:
+        Update to OpenStudio-HPXML 1.9/OpenStudio 3.9/EnergyPlus 24.2.
+
+        OpenStudio-HPXML: `pull request 1883 <https://github.com/NREL/OpenStudio-HPXML/pull/1883>`_
+
+        Assignees: Joe Robertson, Scott Horowitz
+
+
+    .. change::
+        :tags: bugfix, characteristics
+        :pullreq: 1265
+        :tickets: 1236
+
+        **Date**: 2024-09-24
+
+        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.
+
+        resstock-estimation: `pull request 420 <https://github.com/NREL/resstock-estimation/pull/420>`_
+
+        Assignees: Lixi Liu
+
+
+    .. change::
+        :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
+        :tickets: 1273
+
+        **Date**: 2024-09-23
+
+        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.
+
+        resstock-estimation: `pull request 424 <https://github.com/NREL/resstock-estimation/pull/424>`_
+
+        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-26
+
+        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-27
+
+        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.
+
+        resstock-estimation: `pull request 416 <https://github.com/NREL/resstock-estimation/pull/416>`_
+
+        Assignees: Joe Robertson
+
+
+    .. change::
+        :tags: workflow, hvac, feature
+        :pullreq: 1304
+        :tickets: 1303
+
+        **Date**: 2024-11-14
+
+        Title:
+        Assign above-grade height for apartment units
+
+        Description:
+        The purpose of this PR is to set a value in ResStockArguments for apartment units based on the type/size of MF building and where the unit is located (lower, middle, or upper story).
diff --git a/docs/read_the_docs/source/changelog/changelog_dev.rst b/docs/read_the_docs/source/changelog/changelog_dev.rst
@@ -3,141 +3,5 @@ Development Changelog
 =====================
 
 .. changelog::
-    :version: v3.4.0
+    :version: v3.5.0
     :released: pending
-
-    .. change::
-        :tags: software, openstudio, feature
-        :pullreq: 1318
-
-        **Date**: 2024-11-19
-
-        Title:
-        Latest OS-HPXML
-
-        Description:
-        Update to OpenStudio-HPXML 1.9/OpenStudio 3.9/EnergyPlus 24.2.
-
-        OpenStudio-HPXML: `pull request 1883 <https://github.com/NREL/OpenStudio-HPXML/pull/1883>`_
-
-        Assignees: Joe Robertson, Scott Horowitz
-
-
-    .. change::
-        :tags: bugfix, characteristics
-        :pullreq: 1265
-        :tickets: 1236
-
-        **Date**: 2024-09-24
-
-        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.
-
-        resstock-estimation: `pull request 420 <https://github.com/NREL/resstock-estimation/pull/420>`_
-
-        Assignees: Lixi Liu
-
-
-    .. change::
-        :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
-        :tickets: 1273
-
-        **Date**: 2024-09-23
-
-        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.
-
-        resstock-estimation: `pull request 424 <https://github.com/NREL/resstock-estimation/pull/424>`_
-
-        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-26
-
-        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-27
-
-        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.
-
-        resstock-estimation: `pull request 416 <https://github.com/NREL/resstock-estimation/pull/416>`_
-
-        Assignees: Joe Robertson
-
-
-    .. change::
-        :tags: workflow, hvac, feature
-        :pullreq: 1304
-        :tickets: 1303
-
-        **Date**: 2024-11-14
-
-        Title:
-        Assign above-grade height for apartment units
-
-        Description:
-        The purpose of this PR is to set a value in ResStockArguments for apartment units based on the type/size of MF building and where the unit is located (lower, middle, or upper story).
diff --git a/docs/read_the_docs/source/changelog/index.rst b/docs/read_the_docs/source/changelog/index.rst
@@ -6,6 +6,7 @@ Changelogs
 .. toctree::
    :titlesonly:
 
+   changelog_3_4_0
    changelog_3_3_0
    changelog_3_2_0
    changelog_3_1_1

diff --git a/resources/buildstock.rb b/resources/buildstock.rb
@@ -5,7 +5,7 @@
 require_relative '../resources/hpxml-measures/HPXMLtoOpenStudio/resources/meta_measure'
 
 module Version
-  ResStock_Version = '3.3.0' # Version of ResStock
+  ResStock_Version = '3.4.0' # Version of ResStock
   BuildStockBatch_Version = '2023.10.0' # Minimum required version of BuildStockBatch
   WorkflowGenerator_Version = '2024.07.20' # Version of buildstockbatch workflow generator