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

CI: update docs and reset tool for checksums #5372

Merged
merged 5 commits into from
Oct 8, 2024

Conversation

EZoni
Copy link
Member

@EZoni EZoni commented Oct 7, 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:

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:


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:

  • Update docs
  • Update tool

@EZoni EZoni added component: documentation Docs, readme and manual component: tests Tests and CI labels Oct 7, 2024
@EZoni EZoni mentioned this pull request Oct 7, 2024
12 tasks
@EZoni EZoni changed the title [WIP] CI: update docs and reset tool for checksums CI: update docs and reset tool for checksums Oct 8, 2024
@EZoni EZoni requested a review from ax3l October 8, 2024 17:51
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, LGTM! :)

@ax3l ax3l enabled auto-merge (squash) October 8, 2024 19:14
@ax3l ax3l merged commit b710896 into ECP-WarpX:development Oct 8, 2024
37 checks passed
@EZoni EZoni deleted the checksums_docs_tools branch October 8, 2024 21:39
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 <axel.huebl@plasma.ninja>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual component: tests Tests and CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants