Rewrite the README to match the repository - #14
Merged
Conversation
The old README described a Polaris/, Frontier/ and Aurora/ directory tree that never existed in this repository, and a section on keeping four byte-identical copies of the sources in sync -- a problem that was eliminated, not mitigated, when the machine branches were consolidated into machines/ with a single src/. Adds what a first-time reader actually needs: what the solver computes, the real layout, a CPU quick start via CMake and a GPU one per machine, the input deck format (including that R is parsed and never used), what the regression test asserts and why, and the Kokkos versions this has actually been built against rather than a guessed lower bound. States plainly that CI covers the CPU build only, so a green badge is not evidence that the Aurora, Polaris or Frontier builds still link.
Maccchiatooo
changed the title
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.
The old README described a Polaris/, Frontier/ and Aurora/ directory tree that
never existed in this repository, and a section on keeping four byte-identical
copies of the sources in sync -- a problem that was eliminated, not mitigated,
when the machine branches were consolidated into machines/ with a single src/.
Adds what a first-time reader actually needs: what the solver computes, the
real layout, a CPU quick start via CMake and a GPU one per machine, the input
deck format (including that R is parsed and never used), what the regression
test asserts and why, and the Kokkos versions this has actually been built
against rather than a guessed lower bound.
States plainly that CI covers the CPU build only, so a green badge is not
evidence that the Aurora, Polaris or Frontier builds still link.
What and why
Where it was tested
./tests/regression.sh build/imexlbmpasses locallyNotes for the reviewer