Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2023.10.0 #401

Merged
merged 7 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion buildstockbatch/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
__title__ = 'buildstockbatch'
__description__ = 'Executing BuildStock projects on batch infrastructure.'
__url__ = 'http://github.com/NREL/buildstockbatch'
__version__ = '2023.6.0'
__version__ = '2023.10.0'
__schema_version__ = '0.3'
__author__ = 'Noel Merket'
__author_email__ = 'noel.merket@nrel.gov'
Expand Down
84 changes: 84 additions & 0 deletions docs/changelog/changelog_2023_10_0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
====================
v2023.10.0 Changelog
====================

.. changelog::
:version: v2023.10.0
:released: 2023-10-17

.. change::
:tags: general, bugfix
:pullreq: 387
:tickets: 385

Removing broken postprocessing tests.

.. change::
:tags: general, bugfix
:pullreq: 384

Introduce '*' as a valid option name in options_lookup.tsv to indicate a
parameter that can take any option and don't need to pass arguments to
measures. Enables buildstock.csv validation for ComStock without blowing
up the size of the options_lookup.tsv file.

.. change::
:tags: bugfix
:pullreq: 386
:tickets: 256

No longer automatically downloads the appropriate singularity image from
S3. Also added validation to ensure the image is in the correct location.

.. change::
:tags: general, feature
:pullreq: 382

For the Residential HPXML Workflow Generator, add a new ``detailed_filepath`` argument
for pointing to user-specified TSV file of electricity tariff file paths. The TSV file can contain
utility rates mapped by State, or any other parameter.

.. change::
:tags: general, feature
:pullreq: 383

For the Residential HPXML Workflow Generator, fixes new ``include_annual_resilience`` argument to true and
adds a new optional ``include_timeseries_resilience`` argument that defaults to false. Also fixes new
``include_annual_bills`` argument to true and ``include_monthly_bills`` argument to false.

.. change::
:tags: postprocessing, feature
:pullreq: 365

Upload buildstock.csv to S3 during postprocessing

.. change::
:tags: feature
:pullreq: 396
:tickets: 377

Allow fractional ``eagle.minutes_per_sim`` for simulations that run less
than a minute. Making that it a required input.

.. change::
:tags: comstock, workflow
:pullreq: 399

Remove default addition of SimulationOutputReport from ComStock workflow generator to avoid multiple instances
when also included in YML. SimulationOutputReport measure must be included in YML to be added to workflow.

.. change::
:tags: eagle, bugfix
:tickets: 393
:pullreq: 397

Updating validation for Eagle output directory to include
``/lustre/eaglefs`` directories.

.. change::
:tags: eagle, bugfix
:pullreq: 398
:tickets: 390

No longer errors out with a "no space left on device" when using the
``weather_files_url`` on Eagle.
77 changes: 0 additions & 77 deletions docs/changelog/changelog_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,80 +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, bugfix
:pullreq: 387
:tickets: 385

Removing broken postprocessing tests.

.. change::
:tags: general, bugfix
:pullreq: 384

Introduce '*' as a valid option name in options_lookup.tsv to indicate a
parameter that can take any option and don't need to pass arguments to
measures. Enables buildstock.csv validation for ComStock without blowing
up the size of the options_lookup.tsv file.

.. change::
:tags: bugfix
:pullreq: 386
:tickets: 256

No longer automatically downloads the appropriate singularity image from
S3. Also added validation to ensure the image is in the correct location.

.. change::
:tags: general, feature
:pullreq: 382

For the Residential HPXML Workflow Generator, add a new ``detailed_filepath`` argument
for pointing to user-specified TSV file of electricity tariff file paths. The TSV file can contain
utility rates mapped by State, or any other parameter.

.. change::
:tags: general, feature
:pullreq: 383

For the Residential HPXML Workflow Generator, fixes new ``include_annual_resilience`` argument to true and
adds a new optional ``include_timeseries_resilience`` argument that defaults to false. Also fixes new
``include_annual_bills`` argument to true and ``include_monthly_bills`` argument to false.

.. change::
:tags: postprocessing, feature
:pullreq: 365

Upload buildstock.csv to S3 during postprocessing

.. change::
:tags: feature
:pullreq: 396
:tickets: 377

Allow fractional ``eagle.minutes_per_sim`` for simulations that run less
than a minute. Making that it a required input.

.. change::
:tags: comstock, workflow
:pullreq: 399

Remove default addition of SimulationOutputReport from ComStock workflow generator to avoid multiple instances
when also included in YML. SimulationOutputReport measure must be included in YML to be added to workflow.

.. change::
:tags: eagle, bugfix
:tickets: 393
:pullreq: 397

Updating validation for Eagle output directory to include
``/lustre/eaglefs`` directories.

.. change::
:tags: eagle, bugfix
:pullreq: 398
:tickets: 390

No longer errors out with a "no space left on device" when using the
``weather_files_url`` on Eagle.
8 changes: 5 additions & 3 deletions docs/changelog/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ Current Migration Guide
.. toctree::
:titlesonly:

migration_2023_06_0
migration_2023_10_0

Change logs
-----------
Changelogs
----------

.. toctree::
:titlesonly:

changelog_2023_10_0
changelog_2023_06_0
changelog_2023_05_0
changelog_2023_01_0
Expand Down Expand Up @@ -47,6 +48,7 @@ Older Migration Guides
.. toctree::
:titlesonly:

migration_2023_06_0
migration_2023_05_0
migration_2023_01_0
migration_2022_12_0
Expand Down
39 changes: 39 additions & 0 deletions docs/changelog/migration_2023_10_0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. |version| replace:: v2023.10.0

=======================================
What's new in buildstockbatch |version|
=======================================

.. admonition:: About this Document

This document describes changes between buildstockbatch version 2022.06.0 and
buildstockbatch version |version|

General
=======

This version should be backwards compatible with previous versions of
buildstockbatch.

See :doc:`changelog_2023_10_0` for details of this change.

This update primarily addresses bugfixes and issues with the Local and Eagle
implementations. Updates to support Kestrel and AWS will be part of
future versions.

Schema Updates
==============

The constraint on the ``minutes_per_sim`` key under the ``eagle`` section of the
schema was relaxed from two hours to eight hours. This change is backwards
compatible as it makes an existing validation constraint less restrictive. It is
now a required inputs, whereas it used to default to 3.

An optional ``max_minutes_per_sim`` argument was added. If it is present, if any
particular simulation takes longer than the amount of time specified, it will be
terminated.

Residential HPXML Workflor Generator Changes
============================================

Joe, can you please fill this out?
joseph-robertson marked this conversation as resolved.
Show resolved Hide resolved
7 changes: 2 additions & 5 deletions docs/changelog/migration_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ What's new in buildstockbatch |version|

.. admonition:: About this Document

This document describes changes between buildstockbatch version 2022.01.0 and
This document describes changes between buildstockbatch version 2022.10.0 and
buildstockbatch version |version|

General
Expand All @@ -20,7 +20,4 @@ See :doc:`changelog_dev` for details of this change.
Schema Updates
==============

The constraint on the ``minutes_per_sim`` key under the
``eagle`` section of the schema was relaxed from two hours to eight hours.
This change is backwards compatible as it makes an existing validation
constraint less restrictive.
Add as changes are made.
5 changes: 5 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,11 @@ The ``-d`` and ``-e`` flags can also be combined if desired
Amazon Web Services (Beta)
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::

The AWS version of buildstockbatch is currently broken. A remedy is in
progress. Thanks for your patience.

The installation instructions are the same as the :ref:`local-install`
installation. You will need to use an AWS account with appropriate permissions.
The first time you run ``buildstock_aws`` it may take several minutes,
Expand Down
Loading