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

Jump to bottom

Add Standard Data Release YAML to GitHub Actions #1329

Merged
merged 32 commits into from
Jan 24, 2025
Merged

Add Standard Data Release YAML to GitHub Actions #1329

merged 32 commits into from
Jan 24, 2025

Conversation

afontani
Copy link
Contributor

@afontani afontani commented Dec 6, 2024 •
edited
Loading

Pull Request Description

This pull request introduces the Standard Data Release (SDR) YAML file into the "develop" branch of ResStock and into GitHub Actions integration-tests. This PR will give contributors on the SDR measures a place to commit changes and aid in completing an end-to-end workflow in CI.

Workflow changes

  1. National Upgrades and Testing Upgrades have been removed
  2. Path upload errors added to .github/workflows/config.yml. Previously was defaulted to "warn" and wasn't catching that a file was missing. This is done by adding if-no-files-found: error to the actions/upload-artifact@v4 action. Example:

    resstock/.github/workflows/config.yml

    Lines 121 to 126 in 037a9df

    - name: Upload precomputed buildstocks
    uses: actions/upload-artifact@v4
    with:
    name: precomputed_buildstocks
    path: test/tests_yml_files/yml_precomputed*/buildstock*.csv
    if-no-files-found: error
  3. The SDR project file tests have been added similarly to the tests for the project national and project testing upgrade files.

Test Modifications

  1. The tests have been updated to remove the tests around the National Upgrades and Testing Upgrades and switch the tests to the SDR project file.
  2. In test/test_analysis_tools.rb: BuildStockBatch sometimes has extra blank columns. This is because of the superset of all columns from all upgrades, not just an individual upgrade. Removing these columns from the test as they are blank.

    resstock/test/test_analysis_tools.rb

    Lines 49 to 54 in 0d7fb07

    # Test if BuildStockBatch has extra columns that are not empty
    buildstockbatch_extras = buildstockbatch.headers - run_analysis.headers
    buildstockbatch_extras -= ['simulation_output_report.applicable'] # buildstockbatch contains simulation_output_report.applicable (old workflow)
    empty_columns.each do |col| # Remove empty columns from the diff. BuildStockBatch sometimes has empty blank columns
    buildstockbatch_extras -= [col]
    end

Area for improved testing

This PR is meant to introduce the SDR project file and do some elementary testing (similar to project national, project testing, and national upgrades). At this point, the tests make sure there is some data and columns. Improving the tests that exist today, building out functional tests, and regression testing are important areas for improvement moving forward. Example: using only 2 datapoints being simulated some upgrades do not get run because the upgrade is invalid for the two units.

Related Pull Requests

None.

Related Issues

Closes #1261 -- "Commit ResStock 2024.2 data release yaml to develop"

Checklist

Required:

Optional (not all items may apply):

@afontani afontani self-assigned this Dec 6, 2024
@afontani afontani added this to the ResStock v3.5.0 milestone Dec 6, 2024
@joseph-robertson

This comment was marked as resolved.

Sign in to view
@afontani afontani changed the title Add Standard Data Release YAML to Integration Tests Add Standard Data Release YAML to GitHub Actions Jan 6, 2025
afontani and others added 3 commits January 7, 2025 22:47
@afontani
Add SRD yaml into integration tests
17a07fc 
Update changelog

Add workflow generator version

update number of allowable upgrades

Add files to .gitignore

update input and output directories

Update options lookup arguments
@afontani
Add utility bills
b7ca9f9
@afontani
Latest results.
416ea9a
afontani and others added 11 commits January 8, 2025 11:30
@afontani
Update integration tests and results processing
eb3be90 
rename sdr yaml file

Unzip and upload sdr upgrade artifact

Add testing for sdr upgrade run with bsb

Reduce upgrade datapoints on national and testing upgrades ymls

revert data point changes and reduce sdr datapoints.

Remove testing and national upgrades

Update process_bsb_analysis

Updates. test_bsb_analysis passing

Fix test_run_analysis

Update testing yml_valid

Update expected warnings

Remove testing_upgrades from gitignore

Update buildstock_missing.csv

Make sdr tests an upgrade

Add the upgrade osw and xml files as requested from SDR

Update the package name

load only headers for comparison

Add commented out production number of data points

remove Zone People Occupant Count: Conditioned Space from timeseries contents

New tsvs with updated well pump

update changelog

update tsvs
@afontani
Latest results.
d043d64
@afontani
Well pump merge changes
b029136 
Increase n_datapoints

Fix option name change from well pump PR

Typo

reduce datapoints
@afontani
Latest results.
4edd694
@afontani
Update analysis tests and results processing
dbe9237 
Update test_upgrade_results

Update test_upgrade_columns

Fix paths

Fix number of expected files

Fix run_analysis file path

Fix missing upgrade results file in run_analysis results

Fix missing upgrade results file in run_analysis results, try 2

Add path errors during artifact upload

Cleanup

Update the expected number of expected results

Switch upgrade to one that applies to all units
@joseph-robertson @afontani
Update README.md.
4c9ed32
@afontani
Fix path
8628fd9 
Fix bsb sdr results csv
@afontani
New tsvs with updated well pump
1234f76
@lixiliu @afontani
Update test analysis tools
851e4bf
@afontani
Latest results.
f22c262
@afontani
Latest results.
122df88
joseph-robertson
joseph-robertson reviewed Jan 15, 2025
View reviewed changes
project_national/sdr_upgrades_tmy3.yml Show resolved Hide resolved
.github/workflows/config.yml Show resolved Hide resolved
docs/read_the_docs/source/changelog/changelog_dev.rst Outdated Show resolved Hide resolved
measures/ApplyUpgrade/resources/constants.rb Show resolved Hide resolved
docs/read_the_docs/source/workflow_inputs/characteristics.rst Outdated Show resolved Hide resolved
resources/data/utility_bills/sdr_rates/README.md Outdated Show resolved Hide resolved
test/test_bsb_analysis.rb Outdated Show resolved Hide resolved
test/test_run_analysis.rb Outdated Show resolved Hide resolved
@afontani afontani merged commit 0610fc1 into develop Jan 24, 2025
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joseph-robertson joseph-robertson joseph-robertson left review comments

Assignees

@afontani afontani

Labels
feature
Projects
None yet
Milestone
ResStock v3.5.0
Development

Successfully merging this pull request may close these issues.

Commit ResStock 2024.2 data release yaml to develop
3 participants
@afontani @joseph-robertson @lixiliu