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

Explanation/example for ParticleBinning units #699

Open
mccoys opened this issue Feb 28, 2024 · 3 comments
Open

Explanation/example for ParticleBinning units #699

mccoys opened this issue Feb 28, 2024 · 3 comments
Labels
documentation related to the included doc happi related to the postprocessing tool happi

Comments

@mccoys
Copy link
Contributor

mccoys commented Feb 28, 2024

The units of ParticleBinning output from happi is not straightforward. Some explanation is given at the end of this section:
https://smileipic.github.io/Smilei/Use/post-processing.html#open-a-particlebinning-diagnostic

But it could be better explained, possibly with an example.

In addition, there may be a better way to do the calculation in the case of AM geometry. Currently, happi divides the result by Lx * Ry^2. But it might be better to divide by pi * Lx * Ry^2. That works when there are no axes along y or z. If there is one of those axes used, maybe the choice would be 2 * Lx * Ry.

@mccoys mccoys added happi related to the postprocessing tool happi documentation related to the included doc labels Feb 28, 2024
@mccoys
Copy link
Contributor Author

mccoys commented Mar 5, 2024

@Z10Frank Any opinion on the AM case?

@mccoys
Copy link
Contributor Author

mccoys commented Mar 22, 2024

More explanation given now: 2e7d5b6

Still need to resolve the AM case

@beck-llr
Copy link
Contributor

beck-llr commented Sep 9, 2024

I think the current behavior makes sense. No need to change it but the documentation could be improved by mentioning the specific case of the AM geometry.
Another very useful addition to the documentation would be to give some hints as to what happens in the case of non standard axis. Typically the case in which the chosen axis is a function returning the radial position.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation related to the included doc happi related to the postprocessing tool happi
Projects
None yet
Development

No branches or pull requests

2 participants