Merge pull request #191 from NREL/release_v0_19

Release v0 19

README.md

@@ -2,11 +2,18 @@
 
 [![CircleCI](https://circleci.com/gh/NREL/buildstockbatch.svg?style=svg&circle-token=4333c59c1b03b3461dfd16798ba04cb26bede4c0)](https://circleci.com/gh/NREL/buildstockbatch)
 
-This set of tools provides an alternative means to PAT to run and manage the batch
-simulations for the
-[OpenStudio-BuildStock](https://github.com/NREL/OpenStudio-BuildStock)
-building stock energy modeling platform. It can be used to run the
-simulations locally, on Amazon Web Services (coming soon), or on NREL's
+This set of tools provides an alternative means to PAT to run and manage the
+batch simulations for the
+[ResStock](https://github.com/NREL/OpenStudio-BuildStock) and
+[ComStock](https://github.com/NREL/comstock) building stock energy models. It
+can be used to run the simulations locally, on Amazon Web Services, or on NREL's
 supercomputers.
 
-For information how to run the simulations please read the [documentation](https://nrel.github.io/buildstockbatch/).
+For information how to install and run simulations please read the
+[documentation](https://nrel.github.io/buildstockbatch/).
+
+## Disclaimer
+
+This software is a pre-release beta and under active development. APIs and input
+schemas are subject to change without notice. While good faith efforts are made
+to document use of the software, technical support is unavailable at this time.

buildstockbatch/__version__.py

@@ -1,9 +1,9 @@
-__title__ = 'buildstock-batch'
+__title__ = 'buildstockbatch'
 __description__ = 'Executing BuildStock projects on batch infrastructure.'
 __url__ = 'http://github.com/NREL/buildstockbatch'
-__version__ = '0.18'
+__version__ = '0.19'
 __schema_version__ = '0.2'
 __author__ = 'Noel Merket'
 __author_email__ = 'noel.merket@nrel.gov'
 __license__ = 'BSD-3'
-__copyright__ = 'Copyright 2018 The Alliance for Sustainable Energy'
+__copyright__ = 'Copyright 2020 The Alliance for Sustainable Energy'

docs/changelog/changelog_0_19.rst

@@ -0,0 +1,108 @@
+==============
+0.19 Changelog
+==============
+
+.. changelog::
+    :version: 0.19
+    :released: October 26, 2020
+
+    .. change::
+        :tags: bugfix, aws
+        :pullreq: 188
+
+        The most recent version of s3fs was causing dependency problems in the
+        EMR bootstrap script. This pins it to an older, working version.
+
+    .. change::
+        :tags: postprocessing, feature
+        :pullreq: 186
+        :tickets:
+
+        Concatenate the schedules.csv (if they exists) to the enduse_timeseries.csv before converting them to parquet
+
+    .. change::
+        :tags: documentation, examples
+        :pullreq: 185
+
+        Some changes to the example config file to ``num_buildings_represented``
+        and ``downselect`` to more accurately do single family detached housing
+        with a downselect.
+
+    .. change::
+        :tags: bugfix, eagle
+        :pullreq: 181
+        :tickets: 158
+
+        Fixing silent errors in simulation job that left an empty output directory.
+
+    .. change::
+        :tags: documentation
+        :pullreq: 167
+        :tickets: 168
+
+        Minor updates to documentation.
+
+    .. change::
+        :tags: bugfix, eagle
+        :pullreq: 179
+        :tickets: 178
+
+        Fixing dependency conflict in installation. 
+
+    .. change::
+        :tags: schema, change
+        :pullreq: 177
+        :tickets: 158
+
+        Updated the yml schema to require the ``n_buildings_represented`` in schema version 0.2.
+
+    .. change::
+        :tags: aws, bugfix
+        :pullreq: 176
+
+        Fixing dependency problem with ruamal.yaml for AWS workflow.
+
+    .. change::
+        :tags: aws, documentation
+        :pullreq: 174
+
+        Adding AWS demo project yaml file.
+
+    .. change::
+        :tags: aws, documentation
+        :pullreq: 167
+
+        Updating docs for AWS
+
+    .. change::
+        :tags: aws, bugfix
+        :pullreq: 163
+
+        Fix bug in AWS postprocessing. 
+
+    .. change::
+        :tags: bugfix, aws
+        :pullreq: 162
+
+        Avoiding bad pandas version on AWS.
+
+    .. change::
+        :tags: bugfix
+        :pullreq: 161
+
+        Avoiding bad pandas version.
+
+    .. change::
+        :tags: documentation
+        :pullreq: 160
+        :tickets: 157
+
+        Specifying workable Docker version for Windows in documentation.
+
+    .. change::
+        :tags: postprocessing, bugfix
+        :pullreq: 152
+        :tickets: 151
+
+        Throws a more descriptive error in post-processing when no simulation
+        results are found.

docs/changelog/changelog_dev.rst

@@ -14,34 +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: postprocessing, feature
-        :pullreq: 186
-        :tickets:
-
-        Concatenate the schedules.csv (if they exists) to the enduse_timeseries.csv before converting them to parquet
-
-    .. change::
-        :tags: documentation
-        :pullreq: 167
-        :tickets: 168
-
-        Minor updates to documentation.
-
-    ..change::
-        :tags: bugfix, eagle
-        :pullreq: 179
-        :tickets: 178
-
-        Fixing dependency conflict in installation. 
-        
-    .. change::
-        :tags: schema, change
-        :pullreq: 177
-        :tickets: 158
-
-        Updated the yml schema to require the ``n_buildings_represented`` in schema version 0.2.
-
-
-

docs/changelog/index.rst

@@ -11,14 +11,15 @@ Current Migration Guide
 .. toctree::
    :titlesonly:
 
-   migration_0_18
+   migration_0_19
 
 Change logs
 -----------
 
 .. toctree::
    :titlesonly:
 
+   changelog_0_19
    changelog_0_18
 
 Development

docs/changelog/migration_0_19.rst

@@ -0,0 +1,21 @@
+===================================
+What's new in buildstockbatch 0.19?
+===================================
+
+.. admonition:: About this Document
+
+    This document describes changes between buildstockbatch version 0.18 and buildstockbatch version 0.19
+
+General
+=======
+
+Changes between these versions focused on bugfixes, performance improvements,
+and documentation updates. See :doc:`changelog_0_19` for details. 
+
+Schema Updates
+==============
+
+Only one change was made to the schema, which is to require
+``n_buildings_represented``. Previously that field wasn't *required* in the
+schema, but the simulation would fail without it. Therefore, no changes should
+be required to existing working project files.

docs/index.rst

@@ -25,7 +25,7 @@ supercomputer, Eagle.
 Updates & Changelog
 ===================
 
-:doc:`Migration from 0.17 to 0.18 <changelog/migration_0_18>`
+:doc:`Migration from 0.18 to 0.19 <changelog/migration_0_19>`
 
 .. toctree::
    :maxdepth: 2