API reference

The API of the Xsuite library is documented in the following sections:

• Xobjects API
  • Contexts
    • Cupy context
    • PyOpenCL context
    • CPU context
• Xpart API
  • The particle class
    • Particles
  • The build_particles function
    • build_particles()
  • Longitudinal coordinates generation
    • generate_longitudinal_coordinates()
  • Normalized transverse coordinates generation
    • Gaussian
    • Polar grid
    • Uniform circular sector
    • Pencil
  • Gaussian bunch generation (6D)
    • generate_matched_gaussian_bunch()
• Xtrack API
  • Line
    • Line
  • Tracker
    • Tracker
  • Beam elements
    • Drift
    • Multipole
    • Cavity
    • RFMultipole
    • DipoleEdge
    • XYShift
    • SRotation
    • LimitEllipse
    • LimitRect
    • LimitRectEllipse
    • LimitRectPolygon
  • Monitors
    • ParticlesMonitor
  • Beam interaction
    • BeamInteraction
  • BeamElement base class
    • BeamElement
  • Loss location refinement
    • LossLocationRefinement
• Xfields API
  • Beam elements
    • Space Charge 3D
    • Space Charge Bi-Gaussian
    • Beam-beam Bi-Gaussian 2D
    • Beam-beam Bi-Gaussian 3D
  • Field Maps
    • Beam-beam Tri-linear Iterpolated Field Map
    • Beam-beam Bi-Gaussian Field Map
  • Solvers
    • FFT Solver 3D
    • FFT Solver 2.5D