search

campa-consortium / lattice-standard

An effort to create a standard to promote lattice information exchange for particle accelerators.
Creative Commons Attribution 4.0 International
5 stars 3 forks source link

Organization of lattice element parameters. #10

Open DavidSagan opened 1 week ago

DavidSagan commented 1 week ago

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 commented 1 week ago

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