User's guide structure improvement

[ewaagaard]

I believe that the overarching structure of Xsuite user's guide could be further enhanced. Now we start having too many articles, many of which fall into the same subdomain.

For instance, I would suggest that

• Installation and Getting started: single-particle tracking remain as their own categories
• Save an Xtrack Line to a json file and Data management in Xsuite could remain separate, but under a new category called for instance "Saving and loading objects"
• Deferred expressions from MAD-X and Interface to PyHEADTAIL could maybe be included under a new category called "Working with other simulation codes" or similar
• Particles monitors and Working with Particles objects could maybe enter a new category "Tracking particles"
• Everything related to 4D and 6D Twiss, and Match twiss parameters, could maybe be grouped together under "Transverse dynamics" or even "Twiss"
• Freeze longitudinal coordinates and some others could maybe enter a new category "Longitudinal dynamics"
• Combined CPU - GPU simulations and Optimize line and tracker for multi-turn tracking speed could maybe go into the new category "Speeding up simulations"
• Space charge and eventually IBS could go under "Collective effects"

These new categories are only suggested names, there could also be a more logical structure. But I think that for a new user new categories of this type could be very helpful.

[giadarol]

Hi Elias, thanks for the feedback.
I think for now a flatter structure helps the user to find things and notice new additions.
Definitely to be reviewed at a later stage when the guide will grow further.