PyECLOUD

PyECLOUD simulates electron cloud effects in particle accelerators. It supports electron cloud buildup simulations and, together with PyHEADTAIL, simulations of the interaction between the cloud and the beam.

Start with installation and a buildup simulation, then explore beam dynamics, input parameters, outputs, and the underlying physical models.

Simulation modes and packages

• Buildup: a prescribed beam drives the electron cloud at an accelerator section.

• Beam dynamics: PyHEADTAIL and PyECLOUD exchange beam/cloud kicks for single-bunch and coupled-bunch studies.

• Ion-cloud studies: additional cloud species and cross-ionization models support studies involving ions.

Package	Role
PyECLOUD	Cloud generation, tracking, emission, and beam coupling
PyPIC (pypic-poisson on PyPI)	Particle-in-cell field solvers; installed as a dependency
PyHEADTAIL	Beam dynamics for coupled simulations
PyPARIS	Serial, multiprocessing, and MPI launchers, included with PyECLOUD
PyPARIS_sim_class, PyPARIS_CoupledBunch_sim_class	Configurable simulation classes, included with PyECLOUD
PyKLU	Default sparse solver; installed as a dependency
nafflib	Optional frequency analysis, available on PyPI

Getting started

• Installation
  • Released packages from PyPI
  • Optional packages
  • Editable installation from Git

Tutorials

• Electron cloud buildup
• Plotting buildup results
• Single-bunch beam dynamics
• Parallel execution
• Saving and restarting simulations

Batch jobs

• HTCondor at CERN
  • Buildup simulation scans
  • Stability simulations with continuation
  • Where files live
  • Python environment
  • Output transfers and held jobs

Reference

• Buildup simulation inputs
  • Simulation parameters
  • Machine parameters
  • Beam parameters
  • Secondary emission parameters
  • Simulations with multiple clouds
• Single-bunch simulation parameters
  • Initial imports
  • Description of the accelerator
  • Transverse feedback
  • Beam parameters
  • Longitudinal slicing
  • Number of macroparticles in the bunch
  • Multijob setup
  • Stop criteria
  • Saving settings
  • Footprint mode
  • Electron cloud settings
• Buildup simulation outputs
  • Read a result
  • Time series
  • Bunch passages and histograms
  • Other and optional fields
• Physical models and numerical algorithms
  • General references
  • Particle tracking and fields
  • Emission and ionization
  • Beam coupling and computational methods
• Citing PyECLOUD

Contributing

• Working on the documentation
• Contributors

The original wiki remains available as a historical source. See Citing PyECLOUD when using the code in a publication.