Added struphy-plots integration - #408
Draft
max-models wants to merge 219 commits into
Draft
max-models wants to merge 219 commits into
max-models wants to merge 219 commits into
Conversation
…ve a single periodic element, so their field size is 1, making size - 1 == 0
This branch has not been deployed
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
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.
Merge after #406
Integrate the optional plasma-plots package with
Output, so creating an output handle automatically enables whole-run plots and diagnostics throughout.plotandout.analysis, plus the.plasmaaccessors on xarray products. Also enable automatic post-processing under MPI and direct selection of particle products by their full catalog keys.Install
plasma-plotswith:pip install plasma-plotsorpip install "struphy[pproc]".Solves the following issue(s):
Makes plasma-plots available directly from the Struphy output API and removes the need for a separate
pproc()call before first accessing unprocessed products under MPI.Core changes:
struphy[plots]extra, which installsplasma-plots.Outputloads the package when installed; output reading remains available without it. Accessing plotting or analysis without the package gives installation guidance.evaluate()andpproc()choose parallel processing automatically when the current MPI job has the same number of ranks as the saved simulation, and more than one rank. Otherwise, rank 0 processes the run while the remaining ranks wait. An explicitparallel=TrueorFalseoverrides the selection.out.evaluate("kinetic_ions/e1_v1_density/delta_f"), including coordinate selections. Reject combining a full key withdataset=.Model-specific changes:
None.
Documentation changes:
Update the README, quickstart, user guide, and output API documentation with plasma-plots installation, accessor examples, and MPI processing behavior.