Skip to content

Automate ssc differ#921

Merged
dguittet merged 12 commits into
patchfrom
automate_ssc_differ
Feb 9, 2022
Merged

Automate ssc differ#921
dguittet merged 12 commits into
patchfrom
automate_ssc_differ

Conversation

@dguittet

@dguittet dguittet commented Feb 8, 2022

Copy link
Copy Markdown
Collaborator

Description

Automating the SSC Variable and SAM default differ to run in Github Actions

Requires an easy way to query and download the previous SAM version, this is done by adding the download paths to the Github Releases: such as for the 2021.12.02.r0.ssc.267 release here: https://github.com/NREL/SAM/releases/tag/2021.12.02.r0.ssc.267

Steps to Use:

  1. Create a new Release in SAM repo and make it a "Pre-release". Add the download links
  2. Trigger SAM's Github Actions by making a Push or a Pull Request
  3. Download the Artefact version_diff.json from Github Actions and use in Release Notes

Here's an example Github Action run: https://github.com/NREL/SAM/actions/runs/1809701751

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

If you have added a new compute module in a SSC pull request related to this one, be sure to check the Process Requirements.

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@dguittet dguittet changed the base branch from develop to patch February 8, 2022 01:03
@sjanzou

sjanzou commented Feb 8, 2022

Copy link
Copy Markdown
Collaborator

@dguittet, looking at the example https://github.com/NREL/SAM/actions/runs/1809701751 and the failing check, what actions should be taken by whoever is running the action? Should this be a pull request failure in the future?

@dguittet

dguittet commented Feb 8, 2022

Copy link
Copy Markdown
Collaborator Author

@sjanzou That example is successful. The latest failed due to differences in the test script of the defaults. I'm not sure why that is as this PR has no impact on the test files or those results.

@brtietz

brtietz commented Feb 8, 2022

Copy link
Copy Markdown
Collaborator

@dguittet I suspect these are due to underlying SSC changes. It seems reasonable that NatLabRockies/ssc#743 would impact the stand alone battery LCOE.

@dguittet

dguittet commented Feb 8, 2022

Copy link
Copy Markdown
Collaborator Author

@brtietz That makes sense it's SSC changes. I added upload of the test_results_linux64.csv to Github Actions so we can use it in the test results update process, and will update the test results.

@brtietz

brtietz commented Feb 8, 2022

Copy link
Copy Markdown
Collaborator

@dguittet Thanks that's a great addition! The bad news is that the CI chooses pass/fail based on the comparison with the Windows test results, the linux results are info only. I could make a PR with the new Windows results if that's helpful.

@dguittet

dguittet commented Feb 8, 2022

Copy link
Copy Markdown
Collaborator Author

@brtietz It would be great to have a Windows test eventually! But it doesn't have to be right now unless you happen to already have it on your list.

Comment thread .github/workflows/ci.yml Outdated

@brtietz brtietz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nice work!

@dguittet dguittet merged commit eb2fc14 into patch Feb 9, 2022
@dguittet dguittet deleted the automate_ssc_differ branch February 9, 2022 00:06
@sjanzou

sjanzou commented Feb 10, 2022

Copy link
Copy Markdown
Collaborator

@dguittet , did these changes get merged into develop, too?

@dguittet dguittet restored the automate_ssc_differ branch February 10, 2022 21:25
@dguittet

Copy link
Copy Markdown
Collaborator Author

@sjanzou Thanks for the reminder!

@dguittet dguittet deleted the automate_ssc_differ branch February 10, 2022 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants