v2024.11.0 Changelog

v2024.11.0

Released: 2024-11-05

general

• [general] [feature]

  Add a step_failures section to json results files with error messages from OpenStudio simulations.

  References: pull request 437

• [general] [feature]

  Add GCP implementation.

  References: pull request 423

• [general] [feature]

  Add a new version (2024.07.19) of the Residential HPXML Workflow Generator that changes UpgradeCosts from reporting measure to a regular measure. ReportHPXMLOutput is no longer called. This feature is created to support the corresponding update in ResStock (https://github.com/NREL/resstock/pull/1253)

  To facilitate the creation of new version, the workflow generator code base is refactored to have one folder for each version. New yaml schema (v0.4) is created that defines a version key for the workflow_generator block. The base class loads the appropriate version of the workflow_generator based on the version key. If version key is missing (when using older schema), it is defaulted to the oldest available version (2024.07.18).

  References: pull request 458

• [general] [feature]

  Add a new version (2024.07.20) of the Residential HPXML Workflow Generator that exposes optional include_annual_bills (defaults to true) and include_monthly_bills (defaults to false) arguments for reporting annual and monthly utility bill outputs, respectively.

  References: pull request 461

• [general]

  Refactor docker_base to use inversion of control so that it can more strongly and easily ensure consistency between various implementations (GCP implementation to come). This also includes teasing apart the several batch prep steps (weather, assets, and jobs) into their own methods so they can each be more easily understood, shared, and maintained.

  References: pull request 421

• [general]

  Refactor AWS code so it can be shared by the upcoming GCP implementation.

  References: pull request 422

• [general] [bugfix]

  A bugfix for gracefully handling empty data_point_out.json files.

  References: pull request 426

• [general]

  Add helper to log a summary of how many simulations succeeded and failed at the end of a job.

  References: pull request 435

• [general]

  Clean up handling of weather files in GCP/AWS implementations: only upload files that are required, and fail with clearer messaging if any files are missing.

  References: pull request 436

• [general]

  Refactor WorkflowGenerator.

  References: pull request 456

• [general] [bugfix]

  Stop creating dask _metadata files for the timeseries parquet files since it crashes the postprocessing.

  References: pull request 464

• [general] [bugfix]

  Add --continue_upload flag to allow only uploading the missing files to s3.

  References: pull request 466

• [general]

  Remove support for Python 3.8, 3.9, and 3.10. Add support for Python 3.12.

  References: pull request 472

• [general]

  Remove eagle related code and references since eagle is retired.

  References: pull request 472

• [general]

  Append schedules to the timeseries files.

  References: pull request 465

schema

• [schema] [bugfix]

  Requires os_version and os_sha in the project file.

  References: pull request 450

hpc

• [hpc] [bugfix]

  Updates the bind mount for apptainer to include the whole resources directory instead of just the hpxml-measures directory. Makes it work with newer versions of ResStock.

  References: pull request 467

aws

• [aws] [feature]

  Major update to get AWS Batch run environment working.

  References: pull request 345