Docs: improve "Workflows" section for developers #5525
Conversation
This file contains 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
EZoni
added
component: documentation
EZoni
changed the title
EZoni
commented
Dec 21, 2024
Comment on lines
-233
to
-270
|
|
||
| Useful tool for plotfile comparison: ``fcompare`` | ||
| ------------------------------------------------- | ||
|
|
||
| AMReX provides ``fcompare``, an executable that takes two ``plotfiles`` as input and returns the absolute and relative difference for each field between these two plotfiles. For some changes in the code, it is very convenient to run the same input file with an old and your current version, and ``fcompare`` the plotfiles at the same iteration. To use it: | ||
|
|
||
| .. code-block:: sh | ||
|
|
||
| # Compile the executable | ||
| cd <path to AMReX>/Tools/Plotfile/ # This may change | ||
| make -j 8 | ||
| # Run the executable to compare old and new versions | ||
| <path to AMReX>/Tools/Plotfile/fcompare.gnu.ex old/plt00200 new/plt00200 | ||
|
|
||
| which should return something like | ||
|
|
||
| .. code-block:: sh | ||
|
|
||
| variable name absolute error relative error | ||
| (||A - B||) (||A - B||/||A||) | ||
| ---------------------------------------------------------------------------- | ||
| level = 0 | ||
| jx 1.044455105e+11 1.021651316 | ||
| jy 4.08631977e+16 7.734299273 | ||
| jz 1.877301764e+14 1.073458933 | ||
| Ex 4.196315448e+10 1.253551615 | ||
| Ey 3.330698083e+12 6.436470137 | ||
| Ez 2.598167798e+10 0.6804387128 | ||
| Bx 273.8687473 2.340209782 | ||
| By 152.3911863 1.10952567 | ||
| Bz 37.43212767 2.1977289 | ||
| part_per_cell 15 0.9375 | ||
| Ex_fp 4.196315448e+10 1.253551615 | ||
| Ey_fp 3.330698083e+12 6.436470137 | ||
| Ez_fp 2.598167798e+10 0.6804387128 | ||
| Bx_fp 273.8687473 2.340209782 | ||
| By_fp 152.3911863 1.10952567 | ||
| Bz_fp 37.43212767 2.1977289 |
There was a problem hiding this comment.
Do developers really use this when adding automated tests? If it's a tool that isn't used much, I would rather remove this section to keep the documentation as concise as possible.
There was a problem hiding this comment.
I do use fcompare occasionally. But I agree that this level of description is not needed. Maybe some place here just mention that that tool is available.
EZoni
changed the title
EZoni
commented
Jan 9, 2025
There was a problem hiding this comment.
FYI, this was actually renamed from run_clang_tidy_locally.rst and modified later on, but the number of changes is large enough to make GitHub display it as a new file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Suggestion for reviewers:
Compare the preview of the new documentation available from the CI check
docs/readthedocs.org:warpxwith the existing documentation available online.Improve the Workflows documentation for developers, so far only the following sections:
To-do: