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

Bldgs represented arg #177

Merged
merged 8 commits into from Aug 27, 2020
Merged

Bldgs represented arg #177

merged 8 commits into from Aug 27, 2020

Conversation

aspeake
Copy link
Contributor

@aspeake aspeake commented Aug 21, 2020

Pull Request Description

Makes the n_buildings_represented argument required in the 0.2 yml schema. Prior to this, if the argument was not included, no simulations would run, and the only error output would be a post-processing error, and therefore very difficult to debug.

Checklist

Not all may apply

  • Code changes (must work)
  • Tests exercising your feature/bug fix (check coverage report on CircleCI build -> Artifacts)
  • All other unit tests passing
  • Update validation for project config yaml file changes
  • Update existing documentation
  • Run a small batch run to make sure it all works (local is fine, unless an Eagle specific feature)
  • Add to the changelog_dev.rst file and propose migration text in the pull request

@aspeake aspeake requested a review from nmerket August 21, 2020 18:16
@aspeake
Copy link
Contributor Author

aspeake commented Aug 21, 2020

@nmerket Was it correct to update the 0.18 migration documentation for this fix? Or is there a different doc file I should update?

Copy link
Member

@nmerket nmerket left a comment

Choose a reason for hiding this comment

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

This makes sense to me!

Comment on lines 83 to 84
key, and ``buildstock_csv`` needs to be changed to ``precomputed_sample``. The new schema would now look like:
key, the ``n_buildings_represented`` key, and ``buildstock_csv`` needs to be changed to ``precomputed_sample``. The new schema would now look like:
Copy link
Member

Choose a reason for hiding this comment

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

Rather than change this here, you'll want to document this change in
https://github.com/NREL/buildstockbatch/blob/bldgs_represented_arg/docs/changelog/changelog_dev.rst

@aspeake aspeake marked this pull request as ready for review August 27, 2020 14:15
@nmerket nmerket merged commit 766472f into develop Aug 27, 2020
@nmerket nmerket deleted the bldgs_represented_arg branch August 27, 2020 16:07
@rHorsey rHorsey mentioned this pull request Oct 27, 2020
7 tasks
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.

None yet

2 participants