User’s guide

• Installation
  • Basic installation
  • Developer installation
  • Optional dependencies
  • GPU support
  • Install Miniforge
  • Install on Apple silicon
• Getting started: single-particle tracking
  • A simple example
  • Step-by-step description
• Save an Xtrack Line to a json file
• Working with Particles objects
  • Introduction
  • Building particles with the Particles class
  • The build_particles function
  • Generating particles distributions
  • Copying a Particles object (optionally across contexts)
  • Saving and loading Particles objects to/from dictionary or file
  • Merging and filtering Particles objects
  • Accessing particles coordinates on GPU contexts
• Deferred expressions from MAD-X
• Twiss
  • Basic usage
  • Access option of twiss table
  • 4d method for twiss and build_particles
  • Non linear momentum detuning
• Match twiss parameters
  • Match tunes and chromaticities
  • Match an orbit bump
• Tune footprint
  • Basic usage
  • Linear rescale on knobs
• Particles monitors
  • The easy way
  • Custom particles monitor
  • Multi-frame particles monitor
  • Particles monitor as beam elements
  • Particles monitor in stand-alone mode
• Acceleration
• Synchrotron radiation
• Compensate radiation energy loss (tapering)
• Freeze longitudinal coordinates
  • Freezing longitudinal when calling methods
  • Freezing longitudinal coordinates a with block
  • Freezing longitudinal coordinates with Line method
• Exciter beam element
  • Samples
  • Element
• Fast lattice changes
• Optimize line for multi-turn tracking speed
• Tracking with collective elements
  • Example
  • How does it work?
• Collimation
  • Loss location refinement
  • Beam interaction (generation of secondary particles)
• Space charge
  • Example
• Interface to PyHEADTAIL
• Combined CPU - GPU simulations
• Data management in Xsuite
  • Hybrid objects, xofields, xobjects
  • Contexts and buffers
  • Move and copy operations
  • Memory management in xtrack trackers
  • References
  • Advanced memory behaviours with HybridClass