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

Organization of lattice element parameters. #10

Open
DavidSagan opened this issue Nov 16, 2024 · 1 comment
Open

Organization of lattice element parameters. #10

DavidSagan opened this issue Nov 16, 2024 · 1 comment

Comments

@DavidSagan
Copy link
Contributor

There is the question as to how to organize lattice element parameters. I propose a hierarchical structure (much like OpenPMD). At the top level there can be groups like MagMultipole, ElecMultipole, RF, Bend, Alignment, etc. All names should be case sensitive. My inclination is to use Upper camel case for top level names.

A dot . (alternatively this could be a slash /) can be used as a separator between levels. For example, Bend.angle, Bend.e1, RF.frequency, etc. My inclination is to use lower case for the second level names.

There may be parameters that are so unique that there are no other parameters to naturally group them with. In this case, these parameters can be left ungrouped. Examples may be the element length and the element name. The length could be represented by L, length or some such and the name by Name or name.

Thoughts?

@jlvay
Copy link
Member

jlvay commented Nov 18, 2024

I like it. I would vote for the dot rather than slash.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants