Xsuite

Xsuite is a collection python packages for the simulation of the beam dynamics in particle accelerators. It supports different computing platforms, in particular conventional CPUs and and Graphic Processing Units (GPUs).

Xsuite is composed by the following packages:

• Xobjects: infrastructure to manage the memory, compile and execute code on different computing platforms;

• Xline: package to create or import machine lattice descriptions;

• Xpart: package to generate and manipulate ensembels of particles;

• Xtrack: single-particle tracking library;

• Xfields: computation of the electromagnetic fields generated by particle ensambles using Particle In Cell (PIC) solvers or analytical distributions.

The implemented physics models are being documented in this guide. The source code is available in these GitHub repositories.

Table of contents

• User’s guide
  • Installation
  • Single-particle tracking
  • Tracking with collective elements
  • Quasi-frozen and PIC space-charge simulations
  • Interface to PyHEADTAIL
• Developer’s guide
  • Definition a new beam element for Xtrack
  • Multiplatform programming with xobjects
  • Code autogeneration
• Physics guide
• API reference
  • Xobjects API
  • Xline API
  • Xpart API
  • Xtrack API
  • Xfields API

Indices and tables

• Index

• Module Index

• Search Page