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

Creates HERON/data directory to store common HERON data. #351

Merged
merged 9 commits into from
Apr 9, 2024

Conversation

joshua-cogliati-inl
Copy link
Collaborator

@joshua-cogliati-inl joshua-cogliati-inl commented Apr 1, 2024


Pull Request Description

What issue does this change request address?

Closes #352

What are the significant changes in functionality due to this change request?

Creates a %HERON_DATA% magic word used in src/Placeholders to find HERON/data
Moves shared data from inside tests to HERON/data


For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

  • 1. Review all computer code.
  • 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
  • 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
  • 4. Automated Tests should pass.
  • 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large tes.
  • 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
  • 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
  • 8. If an analytic test is changed/added, the the analytic documentation must be updated/added.
  • 9. If any test used as a basis for documentation examples have been changed, the associated documentation must be reviewed and assured the text matches the example.

Copy link
Collaborator

@GabrielSoto-INL GabrielSoto-INL left a comment

Choose a reason for hiding this comment

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

Changes LGTM and add a lot better organization of auxiliary HERON data. As had been previously discussed, added a suggestion for updating the input specs to instruct the user about using the %HERON_DATA% environment variable

Copy link
Collaborator

Choose a reason for hiding this comment

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

In this file, it might be worth updating the InputData descriptions within the get_input_specs( ) methods of the ARMA(Placeholder) and Function(Placeholder) classes to talk about using %HERON_Data% instead of/in addition to %HERON%. In the modified files, these are lines 169 and 264 respectively (could not find a way to link to them directly in this comment).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Okay, I added descriptions of HERON_DATA to those get_input_specs.

@PaulTalbot-INL PaulTalbot-INL merged commit 78c0e4c into idaholab:devel Apr 9, 2024
4 checks passed
@joshua-cogliati-inl joshua-cogliati-inl deleted the heron_data branch April 10, 2024 14:36
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.

[TASK] Better handling for common HERON data.
3 participants