Merged
Conversation
hsaunders1904
force-pushed
the
hsaunders1904/26_update_readme_documentation
branch
from
8c86bb8 to
31acb9a
Compare
hsaunders1904
deleted the
hsaunders1904/26_update_readme_documentation
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates documentation to reflect the current state of the project.
The README has been updated to reflect the current capabilities of Hippo.
This includes pointing to implemented validation cases.
An example of how to set up a Hippo case has been added to the MOOSE docs. The docs are built in CI and (if I've done it right) are deployed to GitHub pages if the CI is running against the main branch.
I've also documented the FPE signal trapping issues I've run into.
Related Issue
Resolves #26
Resolves #19
Checklist