Merge pull request #371 from NREL/release_2023.05.0

Release 2023.05.0
NREL · May 24, 2023 · bd389bf · bd389bf
2 parents 174fb4d + ecb73c5
commit bd389bf
Show file tree

Hide file tree

Showing 5 changed files with 127 additions and 66 deletions.
diff --git a/buildstockbatch/__version__.py b/buildstockbatch/__version__.py
@@ -4,7 +4,7 @@
 __title__ = 'buildstockbatch'
 __description__ = 'Executing BuildStock projects on batch infrastructure.'
 __url__ = 'http://github.com/NREL/buildstockbatch'
-__version__ = '2023.1.0'
+__version__ = '2023.5.0'
 __schema_version__ = '0.3'
 __author__ = 'Noel Merket'
 __author_email__ = 'noel.merket@nrel.gov'

diff --git a/docs/changelog/changelog_2023_05_0.rst b/docs/changelog/changelog_2023_05_0.rst
@@ -0,0 +1,71 @@
+====================
+v2023.05.0 Changelog
+====================
+
+.. changelog::
+    :version: v2023.05.0
+    :released: 2023-05-24
+
+    .. change::
+        :tags: general, feature
+        :pullreq: 349
+        :tickets: 300
+
+        Remove docker dependency for local runs.
+
+    .. change::
+        :tags: general, bugfix
+        :pullreq: 355
+        :tickets: 352
+
+        Fix an issue with schedules datatype that was causing the crash of postporcessing at the final step.
+
+    .. change::
+        :tags: workflow, feature
+        :pullreq: 353
+
+        Avoid unnecessarily validating the HPXML file twice after having slightly changed the ``residential_hpxml`` workflow.
+
+    .. change::
+        :tags: validation, feature
+        :pullreq: 362
+
+        Enforce Athena database name and table name to follow strict alphanumeric only naming convention.
+
+    .. change::
+        :tags: validation, feature
+        :pullreq: 366
+
+        Add a references section in the yaml schema to allow defining the anchors at a single place.
+
+    .. change::
+        :tags: comstock, changed, validation, eagle
+        :pullreq: 350
+
+        Allows up to 8 hours per simulation in the ``minutes_per_sim`` validator
+        under the ``eagle`` section of a configuation YAML. This is required to
+        allow long-running ComStock models to be segmented into their own YAML
+        to allow for more efficient use of HPC resources.
+
+    .. change::
+        :tags: general, feature
+        :pullreq: 363
+
+        For the Residential HPXML Workflow Generator, fixes all ``include_annual_foo`` arguments to true (except
+        for ``include_annual_system_use_consumptions`` which is fixed to false). Also fixes
+        ``include_timeseries_system_use_consumptions`` to false.
+
+    .. change::
+        :tags: resstock, workflow generator, deprecated
+        :pullreq: 370
+
+        Removing the ``residential_default`` workflow generator and adding a
+        validator to eagle.py to ensure the output directory is on a Lustre
+        filesystem directory.
+
+    .. change::
+
+        :tags: resstock, openstudio
+        :pullreq: 368
+
+        Updating default OpenStudio version to 3.6.1
diff --git a/docs/changelog/changelog_dev.rst b/docs/changelog/changelog_dev.rst
@@ -14,67 +14,3 @@ Development Changelog
         This is an example change. Please copy and paste it - for valid tags please refer to ``conf.py`` in the docs
         directory. ``pullreq`` should be set to the appropriate pull request number and ``tickets`` to any related
         github issues. These will be automatically linked in the documentation.
-
-    .. change::
-        :tags: general, feature
-        :pullreq: 349
-        :tickets: 300
-
-        Remove docker dependency for local runs.
-
-    .. change::
-        :tags: general, bugfix
-        :pullreq: 355
-        :tickets: 352
-
-        Fix an issue with schedules datatype that was causing the crash of postporcessing at the final step.
-
-    .. change::
-        :tags: workflow, feature
-        :pullreq: 353
-
-        Avoid unnecessarily validating the HPXML file twice after having slightly changed the ``residential_hpxml`` workflow.
-
-    .. change::
-        :tags: validation, feature
-        :pullreq: 362
-
-        Enforce Athena database name and table name to follow strict alphanumeric only naming convention.
-
-    .. change::
-        :tags: validation, feature
-        :pullreq: 366
-
-        Add a references section in the yaml schema to allow defining the anchors at a single place.
-
-    .. change::
-        :tags: comstock, changed, validation, eagle
-        :pullreq: 350
-
-        Allows up to 8 hours per simulation in the ``minutes_per_sim`` validator
-        under the ``eagle`` section of a configuation YAML. This is required to
-        allow long-running ComStock models to be segmented into their own YAML
-        to allow for more efficient use of HPC resources.
-
-    .. change::
-        :tags: general, feature
-        :pullreq: 363
-
-        For the Residential HPXML Workflow Generator, fixes all ``include_annual_foo`` arguments to true (except
-        for ``include_annual_system_use_consumptions`` which is fixed to false). Also fixes
-        ``include_timeseries_system_use_consumptions`` to false.
-
-    .. change::
-        :tags: resstock, workflow generator, deprecated
-        :pullreq: 370
-
-        Removing the ``residential_default`` workflow generator and adding a
-        validator to eagle.py to ensure the output directory is on a Lustre
-        filesystem directory.
-
-    .. change::
-
-        :tags: resstock, openstudio
-        :pullreq: 368
-
-        Updating default OpenStudio version to 3.6.1
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -11,14 +11,15 @@ Current Migration Guide
 .. toctree::
    :titlesonly:
 
-   migration_2023_01_0
+   migration_2023_05_0
 
 Change logs
 -----------
 
 .. toctree::
    :titlesonly:
 
+   changelog_2023_05_0
    changelog_2023_01_0
    changelog_2022_12_0
    changelog_2022_10_1
@@ -45,6 +46,7 @@ Older Migration Guides
 .. toctree::
    :titlesonly:
 
+   migration_2023_01_0
    migration_2022_12_0
    migration_2022_10_1
    migration_2022_10_0

diff --git a/docs/changelog/migration_2023_05_0.rst b/docs/changelog/migration_2023_05_0.rst
@@ -0,0 +1,52 @@
+=======================================
+What's new in buildstockbatch 2023.05.0
+=======================================
+
+.. admonition:: About this Document
+
+    This document describes changes between buildstockbatch version 2022.1.0 and
+    buildstockbatch version 2023.05.0
+
+See :doc:`changelog_2023_05_0` for full details of changes since the last version.
+
+General
+=======
+
+This version should be backwards compatible with previous versions of
+buildstockbatch. The default version of OpenStudio was changed to 3.6.1, so if
+you require an older version, make sure it is called out in your project file.
+
+Docker no longer required for local runs
+========================================
+
+Docker is no longer a required dependency for running a local run through
+buildstockbatch. As such, the ``buildstock_docker`` cli was replaced with
+``buildstock_local``. The appropriate version of OpenStudio will need to be
+available. See :ref:`local-install` for details.
+
+Residential HPXML Workflow
+==========================
+
+Updates were made to workflow generator arguments, see
+:doc:`../workflow_generators/residential_hpxml` for details.
+
+Residential Default Workflow Removed
+====================================
+
+The ``residential_default`` workflow generator was removed. To use this version
+of buildstockbatch, please update your version of ResStock to on that uses the
+``residential_hpxml`` workflow generator.
+
+Schema Updates
+==============
+
+``output_directory`` is now required in the schema and will not be defaulted.
+
+``postprocessing.aws.athena.database`` limits the database name to be letters,
+numbers, and the underscore (``_`` ) character.
+
+A ``references`` section can now be included in the project yaml file. This can
+be used to define other parts of the file that you want to reuse using yaml
+anchors and references.
+
+``eagle.minutes_per_sim`` can now be extended up to 8 hours.