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

Clean up unit documentation #636

Open
n01r opened this issue Jun 14, 2024 · 0 comments
Open

Clean up unit documentation #636

n01r opened this issue Jun 14, 2024 · 0 comments
Assignees
Labels
component: documentation Docs, readme and manual

Comments

@n01r
Copy link
Member

n01r commented Jun 14, 2024

@SchroederSa brought up that we can still improve the documentation of our units:

Examples from the docs:

  • beam.sigmaPx (float, in momentum) rms Px
  • beam.sigmaPy (float, in momentum) rms Py

'in momentum' could be more precise

beam.sigmaT (float, in radian) rms normalized time difference T

How can the longitudinal position be in radians?

I assume

beam.sigmaPx (float, in momentum) rms Px ----> beam.sigmaPx (float, in radian) rms Px normalised to P_ref
beam.sigmaT (float, in radian) rms normalized time difference T ----> beam.sigmaT (float, in meter) rms time or similar

beam.sigmaPt (float, in energy deviation) rms Pt

I would consistently write the unit in parentheses and afterwards the description

meaning:
beam.VARIABLE (type, in UNIT) what; how

beam.sigmaPx(float, in radian) rms of x-momentum; normalised to Pz of reference particle

Thanks for bringing this up, @SchroederSa, I'll put it on our agenda. :)

@n01r n01r added the component: documentation Docs, readme and manual label Jun 14, 2024
@n01r n01r self-assigned this Jun 14, 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

1 participant