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

Document openPMD particle "columns" if read back to a dataframe #618

Open
ax3l opened this issue May 21, 2024 · 0 comments
Open

Document openPMD particle "columns" if read back to a dataframe #618

ax3l opened this issue May 21, 2024 · 0 comments
Assignees
Labels
component: documentation Docs, readme and manual

Comments

@ax3l
Copy link
Member

ax3l commented May 21, 2024

In our default reading of openPMD beam monitor data, we usually show how to load the beam data into a Pandas dataframe.

# initial/final beam
series = io.Series("diags/openPMD/monitor.h5", io.Access.read_only)
last_step = list(series.iterations)[-1]
initial = series.iterations[1].particles["beam"].to_df()
final = series.iterations[last_step].particles["beam"].to_df()

We need to extend the data analysis documentation to explain what units users can expect in those.

@ax3l ax3l added the component: documentation Docs, readme and manual label May 21, 2024
@ax3l ax3l added this to the Advanced Methods (SciDAC) milestone May 23, 2024
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
Projects
None yet
Development

No branches or pull requests

3 participants