User’s guide

• Installation
  • Basic installation
  • Developer installation
  • Optional dependencies
  • GPU/Multithreading support
  • Install Miniforge
  • Advanced information for developers
• Getting started
  • A simple example
  • Step-by-step description
• Unit conventions
  • Core quantities
• Xsuite environment
  • Overview
  • Variables
  • Elements
  • Lines
  • Reference particles
  • Saving and loading environment or individual lines
  • Loading MAD-X lattices
• Configure lattice model
  • Magnet models and integrators
  • Apply misalignments (tilt, shift) to elements
  • Add multipolar components to elements
  • Extend multipolar component order
  • Propagation of multipolar components to sliced elements
  • Simulation of small rings: drifts, bends, fringe fields
• Twiss
  • Basic usage (ring)
  • Inspecting twiss output
  • 4d method (RF off)
  • Off-momentum twiss
  • Twiss with “initial” conditions
  • Periodic twiss on a portion of a line
  • Beam sizes from twiss table
  • Particles normalized coordinates
  • Reverse reference frame
  • Twiss defaults
  • Twiss with synchrotron radiation
• Match
  • Basic usage
  • Match at specific locations
  • Boundary conditions and target values from existing table
  • Match involving multiple lines
  • Callables and inequalities in targets
  • Matching on results of arbitrary actions
  • Interactive match
  • Create new knobs by matching
  • Targets from variables and from line elements
• Track
  • Tracking particles with Xsuite
  • Dynamic aperture
  • Monitors
  • Start/stop tracking at specific elements
  • Backtracking
  • Freeze longitudinal coordinates
  • Time-dependent line properties
  • Acceleration
  • Off-momentum from RF frequency change
  • Optimize line for multi-turn tracking speed
• Particles
  • 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
• Closed orbit and trajectory correction
  • Basic usage
  • MICADO correction
  • Customized correction
  • Threading
  • Trajectory correction for transfer lines
• Spin and polarization
  • Equilibrium polarization and spin closed solution
  • Tracking with spin and Monte Carlo simulation of radiative depolarization
• Collective effects
  • Tracking with collective elements
  • Xwakes: wakefields and impedances
  • Space charge
  • Beam-beam
  • Combined CPU - GPU simulations
  • Pipeline for multibunch simulations
• Particle-matter interaction and collimation
  • Introduction
  • Collimator objects
  • BaseBlock and EverestBlock
  • Creating a Collimator or Block object
  • Generating particles on a collimator
  • Lossmaps
  • Loss location refinement
  • Material definitions
  • Beam interaction (generation of secondary particles)
  • Linking external codes for material Interactions
• Synchrotron radiation
  • Twiss and track with radiation
  • Compensate radiation energy loss (tapering)
• Intra-Beam Scattering
  • Analytical Growth Rates
  • Steady State Emittances in the Presence of Synchrotron Radiation, Quantum Excitation and Intra-Beam Scattering
  • IBS Kicks for Tracking
• Tune footprint and stability diagram
  • Basic usage
  • Linear rescale on knobs
  • Stability diagram
• 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
• Lost particles state codes