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

Create structured validation and verification cases for Zapdos #261

Open
cticenhour opened this issue Oct 30, 2024 · 0 comments
Open

Create structured validation and verification cases for Zapdos #261

cticenhour opened this issue Oct 30, 2024 · 0 comments
Assignees

Comments

@cticenhour
Copy link
Member

cticenhour commented Oct 30, 2024

We should adopt a more consistent format for any V&V cases we seek to add. I should suggest starting from the example set by another MOOSE-based code, TMAP8 (https://mooseframework.inl.gov/TMAP8/).

In their V&V page (https://mooseframework.inl.gov/TMAP8/verification_and_validation/index.html), they have several common elements:

  • Consistent sections / elements:
    • Description / Introductory information
    • Benchmarks discussion or differences (if comparing against another code)
    • Experimental discussion (if applicable)
    • Analytic solution (if applicable)
    • Results and comparison to experiment/solution
    • Input files used to run the case, and any relevant discussion on their structure, how the capability is tested, etc.
    • References
  • Heavy usage of references
  • Usage of source code, input file, or test specification links or inclusion of snippets to provide relevant context.

I think this promotes being thorough in development of our tests and examples, and provides ready-made onboarding documentation for those interested in learning more about what Zapdos can do.

@cticenhour cticenhour changed the title Create V&V Cases Similar to TMAP8 Create structured validation and verification cases for Zapdos Oct 30, 2024
@csdechant csdechant self-assigned this Nov 22, 2024
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

No branches or pull requests

2 participants