PyHEADTAIL-playground

A collection of jupyter notebooks and scripts for the PyHEADTAIL collective beam dynamics simulation code.

Give it a try and play with PyHEADTAIL, get started by launching a binder instance with a jupyter notebook server in your browser with a simple click:

If you have a CERN account, you can also launch this repository in an interactive SWAN environment. This offers a jupyter notebook server and saves all your files to your EOS space, which is convenient for re-use:

A quick start tutorial explaining the basics of PyHEADTAIL can be found on the top level of this repository:

Quick Start Tutorial for PyHEADTAIL

Full Simulation Examples

In full_simulations/ you find example scripts for full PyHEADTAIL simulations, such as

• LHC head-tail instability

Simulation Notebooks

In simulation_notebooks/ you find jupyter notebooks running and explaining concrete PyHEADTAIL simulation examples, such as

• 2-particle model explaining the transverse mode coupling instability with instructive animations
• transverse ideal resistive and reactive damper with some exponential rise time fitting
• triple splitting as in the CERN Proton Synchrotron RF gymnastics
• space charge tutorial with incoherent footprints in tune diagram

How To Notebooks

With a bit more detail and focus, modules and concepts of PyHEADTAIL are explained in jupyter notebooks in howto_notebooks/. These how-to's deal with

• aperture and loss modelling
• optics function values inferred from beam distribution
• detuning models for chromaticity and octupole amplitude detuning
• generation of macro-particles in different ways
• monitoring of beam distribution during simulation
• thin multipole kicks
• PyHEADTAIL on the GPU tutorial
• matching of arbitrary stationary distributions into arbitrary RF buckets
• deformation of RF bucket potential by longitudinal space charge
• radio frequency quadrupoles for Landau damping
• slicing in the longitudinal plane
• space charge models on the GPU
• Bassetti-Erskine / Gaussian space charge model
• transverse tracking
• wakefield models with dipolar and quadrupolar terms

Further Resources:

The PyHEADTAIL wiki is the entry level for documentation on PyHEADTAIL.

These are some potentially useful and concise slides as an overview on PyHEADTAIL, some from the PyHEADTAIL developer meetings:

• PyHEADTAIL Playground, testing and release process
• GPU integration in PyHEADTAIL
• Space Charge integration in PyHEADTAIL