CI: update docs and reset tool for checksums #5372
Merged
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
commented
Oct 8, 2024
Regression/Checksum/benchmarks_json/test_2d_langmuir_multi.json
Outdated
Show resolved
Hide resolved
EZoni
commented
Oct 8, 2024
EZoni
commented
Oct 8, 2024
Regression/Checksum/benchmarks_json/test_2d_langmuir_multi.json
Outdated
Show resolved
Hide resolved
Regression/Checksum/benchmarks_json/test_2d_langmuir_multi.json
Outdated
Show resolved
Hide resolved
EZoni
changed the title
ax3l
reviewed
Oct 8, 2024
ax3l
reviewed
Oct 8, 2024
ax3l
added a commit
that referenced
this pull request
Oct 9, 2024
The checksums section title was changed to "Checksums on Tests" in the latest version of #5372, but the cross-reference in the testing section wasn't updated and still had the old name "Using checksums". --------- Co-authored-by: Axel Huebl <[email protected]>
dpgrote
pushed a commit
to dpgrote/WarpX
that referenced
this pull request
Oct 23, 2024
The major part of this PR is about updating the docs so that it is a bit easier for developers to connect the section on testing with the section on checksums. Here's a couple of screenshots showing the new content organization for the testing and checksums sections: <p align="center"> <img src="https://github.com/user-attachments/assets/af3df005-6923-4bcf-9f2a-8dcf60c126b2" width="300"> <img src="https://github.com/user-attachments/assets/b290e5bd-0ec3-46c1-93fc-055607220042" width="300"> </p> As part of this PR, I also update the tool that we have to reset checksums locally based on the Azure output. The update is necessary due to a change in ECP-WarpX#5297, as noted in ECP-WarpX#5297 (comment), given that new checksum files are now displayed as follows: ``` New checksums file test_2d_langmuir_multi.json: { "lev=0": { "Bx": 0.0, "By": 5.726296856755232, "Bz": 0.0, "Ex": 3751589134191.326, "Ey": 0.0, "Ez": 3751589134191.332, "jx": 1.0100623329922576e+16, "jy": 0.0, "jz": 1.0100623329922578e+16 }, "electrons": { "particle_momentum_x": 5.668407513430198e-20, "particle_momentum_y": 0.0, "particle_momentum_z": 5.668407513430198e-20, "particle_position_x": 0.6553599999999999, "particle_position_y": 0.65536, "particle_weight": 3200000000000000.5 }, "positrons": { "particle_momentum_x": 5.668407513430198e-20, "particle_momentum_y": 0.0, "particle_momentum_z": 5.668407513430198e-20, "particle_position_x": 0.6553599999999999, "particle_position_y": 0.65536, "particle_weight": 3200000000000000.5 } } ``` as opposed to the old way ``` ---------------- New file for test_2d_langmuir_multi: { "lev=0": { "Bx": 0.0, "By": 5.726296856755232, "Bz": 0.0, "Ex": 3751589134191.326, "Ey": 0.0, "Ez": 3751589134191.332, "jx": 1.0100623329922576e+16, "jy": 0.0, "jz": 1.0100623329922578e+16 }, "electrons": { "particle_momentum_x": 5.668407513430198e-20, "particle_momentum_y": 0.0, "particle_momentum_z": 5.668407513430198e-20, "particle_position_x": 0.6553599999999999, "particle_position_y": 0.65536, "particle_weight": 3200000000000000.5 }, "positrons": { "particle_momentum_x": 5.668407513430198e-20, "particle_momentum_y": 0.0, "particle_momentum_z": 5.668407513430198e-20, "particle_position_x": 0.6553599999999999, "particle_position_y": 0.65536, "particle_weight": 3200000000000000.5 } } ---------------- ``` To-do: - [x] Update docs - [x] Update tool --------- Co-authored-by: Axel Huebl <[email protected]>
dpgrote
pushed a commit
to dpgrote/WarpX
that referenced
this pull request
Oct 23, 2024
The checksums section title was changed to "Checksums on Tests" in the latest version of ECP-WarpX#5372, but the cross-reference in the testing section wasn't updated and still had the old name "Using checksums". --------- Co-authored-by: Axel Huebl <[email protected]>
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.
The major part of this PR is about updating the docs so that it is a bit easier for developers to connect the section on testing with the section on checksums.
Here's a couple of screenshots showing the new content organization for the testing and checksums sections:
As part of this PR, I also update the tool that we have to reset checksums locally based on the Azure output. The update is necessary due to a change in #5297, as noted in #5297 (comment), given that new checksum files are now displayed as follows:
as opposed to the old way
To-do: