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.

Sign up for GitHub

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

Add Standard Data Release YAML to GitHub Actions #1329

Open
wants to merge 20 commits into
base: develop
Choose a base branch
from
Open

Add Standard Data Release YAML to GitHub Actions #1329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
32f3e32
Initial commit of the srd yaml file
afontani Dec 6, 2024
17a07fc
Add SRD yaml into integration tests
afontani Dec 6, 2024
b7ca9f9
Add utility bills
afontani Dec 10, 2024
416ea9a
Latest results.
Dec 10, 2024
eb3be90
Update integration tests and results processing
afontani Dec 10, 2024
d043d64
Latest results.
Dec 4, 2024
b029136
Well pump merge changes
afontani Dec 31, 2024
4edd694
Latest results.
Dec 31, 2024
dbe9237
Update analysis tests and results processing
afontani Dec 31, 2024
4c9ed32
Update README.md.
joseph-robertson Jan 7, 2025
8628fd9
Fix path
afontani Jan 7, 2025
1234f76
New tsvs with updated well pump
afontani Jan 8, 2025
851e4bf
Update test analysis tools
lixiliu Dec 4, 2024
f22c262
Latest results.
afontani Jan 8, 2025
122df88
Latest results.
Jan 8, 2025
32f78ed
Merge remote-tracking branch 'origin/develop' into sdr_yaml_test
afontani Jan 9, 2025
fe36207
Update changelog date
afontani Jan 9, 2025
b859e80
Latest results.
Jan 9, 2025
3eec898
Update new results to the base_results
afontani Jan 9, 2025
5613ee5
remove files
afontani Jan 9, 2025
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
48 changes: 25 additions & 23 deletions .github/workflows/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ jobs:
- name: Upload formatted options_lookup
uses: actions/upload-artifact@v4
with:
path: resources/options_lookup.tsv
name: options_lookup
path: resources/options_lookup.tsv
if-no-files-found: error

unit-tests:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -69,14 +70,16 @@ jobs:
- name: Upload feature samples
uses: actions/upload-artifact@v4
with:
path: resources/buildstock.csv
name: feature_samples
path: resources/buildstock.csv
if-no-files-found: error

- name: Store code coverage
uses: actions/upload-artifact@v4
with:
path: coverage
name: coverage
path: coverage
if-no-files-found: error

analysis-tests:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -108,7 +111,7 @@ jobs:
uses: actions/download-artifact@v4
with:
path: resources
name: options_lookup
name: options_lookup

- name: Generate precomputed buildstocks
run: |
Expand All @@ -121,18 +124,19 @@ jobs:
- name: Upload precomputed buildstocks
uses: actions/upload-artifact@v4
with:
path: test/tests_yml_files/yml_precomputed*/buildstock*.csv
name: precomputed_buildstocks
path: test/tests_yml_files/yml_precomputed*/buildstock*.csv
if-no-files-found: error

- name: Upload run_analysis.rb results
uses: actions/upload-artifact@v4
with:
name: run_analysis_results_csvs
path: |
project_national/results-Baseline.csv
project_testing/results-Baseline.csv
project_national/results-PackageUpgrade.csv
project_testing/results-PackageUpgrade.csv
name: run_analysis_results_csvs
project_national/results-EnvelopeOnlyLightTouchEnvelope.csv
if-no-files-found: error

integration-tests:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -166,23 +170,17 @@ jobs:

buildstock_local project_national/national_baseline.yml
buildstock_local project_testing/testing_baseline.yml

buildstock_local project_national/national_upgrades.yml
buildstock_local project_testing/testing_upgrades.yml
buildstock_local project_national/sdr_upgrades_tmy3.yml

- name: Unzip results
run: |
gunzip -v project_national/national_baseline/results_csvs/*.csv.gz
gunzip -v project_testing/testing_baseline/results_csvs/*.csv.gz

gunzip -v project_national/national_upgrades/results_csvs/*.csv.gz
gunzip -v project_testing/testing_upgrades/results_csvs/*.csv.gz
gunzip -v project_national/sdr_upgrades_tmy3/results_csvs/*.csv.gz

tar -xvf project_national/national_baseline/simulation_output/*.tar.gz -C project_national/national_baseline/simulation_output --wildcards '*results_timeseries.csv' --wildcards '*.xml' --wildcards '*data_point_out.json' --wildcards '*.osw'
tar -xvf project_testing/testing_baseline/simulation_output/*.tar.gz -C project_testing/testing_baseline/simulation_output --wildcards '*results_timeseries.csv' --wildcards '*.xml' --wildcards '*data_point_out.json' --wildcards '*.osw' --wildcards '*in.osm' --wildcards '*in.idf'

tar -xvf project_national/national_upgrades/simulation_output/*.tar.gz -C project_national/national_upgrades/simulation_output --wildcards '*results_timeseries.csv' --wildcards '*.xml' --wildcards '*data_point_out.json' --wildcards '*.osw'
tar -xvf project_testing/testing_upgrades/simulation_output/*.tar.gz -C project_testing/testing_upgrades/simulation_output --wildcards '*results_timeseries.csv' --wildcards '*.xml' --wildcards '*data_point_out.json' --wildcards '*.osw' --wildcards '*in.osm' --wildcards '*in.idf'
tar -xvf project_national/sdr_upgrades_tmy3/simulation_output/*.tar.gz -C project_national/sdr_upgrades_tmy3/simulation_output --wildcards '*results_timeseries.csv' --wildcards '*.xml' --wildcards '*data_point_out.json' --wildcards '*.osw'

- name: Process results
run: |
Expand All @@ -192,20 +190,21 @@ jobs:
- name: Upload integration results
uses: actions/upload-artifact@v4
with:
name: feature_results
path: |
baseline
upgrades
name: feature_results
if-no-files-found: error

- name: Upload buildstockbatch results
uses: actions/upload-artifact@v4
with:
name: buildstockbatch_results_csvs
path: |
project_national/national_baseline/results_csvs/results_up00.csv
project_testing/testing_baseline/results_csvs/results_up00.csv
project_national/national_upgrades/results_csvs/results_up17.csv
project_testing/testing_upgrades/results_csvs/results_up17.csv
name: buildstockbatch_results_csvs
project_national/sdr_upgrades_tmy3/results_csvs/results_up16.csv
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the old upgrade yml files, "17" referred to the final "Package Upgrade" upgrade scenario. I believe the thinking here was that the simulation output would be the most comprehensive for testing purposes. I'm not sure that the final "16" has the same significance here for the new yml file.

Also, you may want to avoid hardcoding "16" here if the new yml will expand over time.

if-no-files-found: error

- name: Run tests
run: |
Expand Down Expand Up @@ -253,8 +252,9 @@ jobs:
- name: Upload base results
uses: actions/upload-artifact@v4
with:
path: test/base_results
name: base_results
path: test/base_results
if-no-files-found: error

- uses: actions/checkout@v4
with:
Expand Down Expand Up @@ -308,8 +308,9 @@ jobs:
- name: Upload comparisons
uses: actions/upload-artifact@v4
with:
path: test/base_results/comparisons
name: comparisons
path: test/base_results/comparisons
if-no-files-found: error

update-results:
runs-on: ubuntu-22.04
Expand Down Expand Up @@ -363,6 +364,7 @@ jobs:
with:
name: documentation
path: docs/read_the_docs/_build/html/
if-no-files-found: error

- name: Commit latest results
shell: bash
Expand Down
7 changes: 5 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
/measures/UpgradeCosts/tests/in*
/measures/UpgradeCosts/tests/*.xml
/project_national/national_baseline
/project_national/national_upgrades
/project_national/sdr_upgrades_tmy3*
/project_testing/testing_baseline
/project_testing/testing_upgrades
/national_baseline
/testing_baseline
/sdr_upgrades_tmy3*
/resources/buildstock.csv
/project_*/**/*.csv
!/project_*/resources/source_report.csv
Expand All @@ -14,6 +16,7 @@
/weather
.vscode/
.DS_Store
buildstockbatch_crash_details.log
**/.ipynb_checkpoints/*
**/data/*
!/resources/data/dictionary/outputs.csv
15 changes: 15 additions & 0 deletions docs/read_the_docs/source/changelog/changelog_dev.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,18 @@ Development Changelog
resstock-estimation: `pull request 436 <https://github.com/NREL/resstock-estimation/pull/436>`_

Assignees: Janet Reyna
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outside of scope of this PR, but this heat pump pool heaters entry is missing a .. change:: line above.


.. change::
:tags: workflow, standard data release
:pullreq: 1329
:tickets: 1261

**Date**: 2024-1-9

Title:
Add Standard Data Release YAML to Integration Tests

Description:
Add an initial Standard Data Release (SDR) YAML file. Add the SDR upgrade file into integration tests to continue progress towards end-to-end testing.

Assignees: Anthony Fontanini
17 changes: 17 additions & 0 deletions docs/read_the_docs/source/workflow_inputs/characteristics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40097,6 +40097,12 @@ Arguments
- Double
-
- The maximum capacity limit applied to the auto-sizing methodology. If not provided, no limit is used.
* - ``heating_system_2_fraction_heat_load_served``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This argument is being added here under "HVAC Secondary Heating Efficiency" because you've added new "Fuel Wall/Floor Furnace" options which assign heating_system_2_fraction_heat_load_served. But that argument is already assigned in "HVAC Secondary Heating Partial Space Conditioning"...

- true
- Frac
- Double
-
- The heat load served fraction of the second heating system. Ignored if this heating system serves as a backup system for a heat pump.
* - ``heating_system_2_has_flue_or_chimney``
- true
-
Expand All @@ -40120,6 +40126,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
- ``heating_system_2_heating_efficiency``
- ``heating_system_2_heating_capacity``
- ``heating_system_2_heating_autosizing_limit``
- ``heating_system_2_fraction_heat_load_served``
- ``heating_system_2_has_flue_or_chimney``

* - Fuel Boiler, 76% AFUE
Expand All @@ -40128,62 +40135,71 @@ From ``project_national`` the list of options, option stock sturation, and optio
- 0.76
- auto
- auto
-
- auto
* - Fuel Boiler, 80% AFUE
- 0.014%
- Boiler
- 0.8
- auto
- auto
-
- auto
* - Fuel Boiler, 90% AFUE
- 0.0024%
- Boiler
- 0.90
- auto
- auto
-
- auto
* - Fuel Furnace, 60% AFUE
- 3.9e-05%
- Furnace
- 0.6
- auto
- auto
-
- auto
* - Fuel Furnace, 76% AFUE
- 0.00052%
- Furnace
- 0.76
- auto
- auto
-
- auto
* - Fuel Furnace, 80% AFUE
- 0.0015%
- Furnace
- 0.8
- auto
- auto
-
- auto
* - Fuel Furnace, 92.5% AFUE
- 0.00082%
- Furnace
- 0.925
- auto
- auto
-
- auto
* - None
- 1e+02%
- none
- 0
- auto
- auto
-
- auto
* - Shared Heating
- 0.0017%
- none
- 0
- auto
- auto
-
- auto
* - Void
- 0%
Expand All @@ -40192,6 +40208,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
-
-
-
-

.. _hvac_secondary_heating_fuel:

Expand Down
Loading
Loading