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

Appx g/enhancement/restructure user data #1608

Merged
merged 5 commits into from
Sep 19, 2023

Conversation

weilixu
Copy link
Collaborator

@weilixu weilixu commented Sep 15, 2023

Pull request overview

Restructure the user data.
Explicitly write out the data requirements for some of the fields in the implemented user data.
More to add in the future.

Separately the responsibility in three aspects:

  1. User data loading (validation functions)
  2. User data handling (handle data for model processing)
  3. Get additionalFeatures (processed data)

Pull Request Author

  • Method changes or additions
  • Data changes or additions
  • Added tests for added methods
  • If methods have been deprecated, update rest of code to use the new methods
  • Documented new methods using yard syntax
  • Resolved yard documentation errors for new code (ran bundle exec rake doc)
  • Resolved rubocop syntax errors for new code (ran bundle exec rake rubocop)
  • All new and existing tests passes
  • If the code adds new require statements, ensure these are in core ruby or add to the gemspec

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a code review on GitHub
  • All related changes have been implemented: method additions, changes, tests
  • Check rubocop errors
  • Check yard doc errors
  • If fixing a defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If a new feature, test the new feature and try creative ways to break it
  • CI status: all green or justified

…andards into appx_g/enhancement/restructure_user_data

# Conflicts:
#	lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm.Model.rb
@weilixu weilixu added the AppendixG Methods to enable the Appendix G model workflow label Sep 15, 2023
@weilixu weilixu self-assigned this Sep 15, 2023
Copy link
Collaborator

@lymereJ lymereJ left a comment

Choose a reason for hiding this comment

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

Looks good to me! I see that the PR also include some clean-up of methods handling DCV. I'm not sure if this was supposed to be part of this PR or another one.

@weilixu
Copy link
Collaborator Author

weilixu commented Sep 18, 2023

Looks good to me! I see that the PR also include some clean-up of methods handling DCV. I'm not sure if this was supposed to be part of this PR or another one.

I accidentally added DCVs. That suppose to be another one. What this PR included is consolidating the template methods into one in the Standard class. I talked to Jerry about consolidating the template method and he is OK with the change. Given the time constraint, I will leave it as is now. I will address the errors in the CI to make sure test cases are passed.

@weilixu weilixu merged commit ad88419 into AppendixG_Dev Sep 19, 2023
@weilixu weilixu mentioned this pull request Sep 22, 2023
16 tasks
@weilixu weilixu deleted the appx_g/enhancement/restructure_user_data branch February 11, 2024 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AppendixG Methods to enable the Appendix G model workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants