SIMBA - Simulations for Integrated Modeling of Beams in Accelerators

SIMBA is a python package for performing start-to-end (S2E) simulations of linear particle accelerators.

It provides a wrapper for several well-known particle tracking codes:

• ASTRA [1]

• GPT [2]

• Elegant [3]

• CSRTrack [4]

• Ocelot [5]

• Cheetah [6]

• Xsuite [7]

• Wake-T [8]

• MAD-X

• Bmad

• OPAL

• Genesis

Setup

Warning

This site is currently under construction.

Some pages may have missing or incomplete reference documentation.

• Installation
  • Cloning from Github
  • Install via pip
  • Install from pypi / conda-forge
  • Required Dependencies
  • Optional Dependencies
• Getting started with SIMBA
  • Lattice Definition
  • Generating an input beam
  • Defining the Lattice Simulation
  • Running SIMBA
• Loading in a Lattice File
  • Setting up a Simulation From Files
  • Functional Parameters
  • Running SIMBA
• Ring Studies and the tracking Block
  • The Settings
  • programs — a Strength Over Turn Number
  • ramp — the Reference Momentum Over Turn Number
  • rf — How the RF Keeps Time
  • What Each Code Can Do
  • Who Counts the Turns
  • What a Ring Run Reports
  • Which Turn a Result Came From
  • What t Means
  • Space charge in Xsuite
  • simba’s Warnings
  • Tracking the Reference Particle
• SimCodes
  • Creating a SimCodes Directory
  • Using a Container Runtime
  • Running on Windows
  • Editing the Executables.yaml file
  • Pointing to a specific location
  • Citing the codes used

Examples

• Getting Started
  • Preparing the simulation and tracking
• SIMBA Beams Module examples
  • Plotting beam parameters
  • Derived objects from the distribution
  • Reading and writing to and from different simulation code formats
• Utility Functions
  • Accessing and modifying elements

Participation

We welcome contributions and suggestions from the community! SIMBA is currently under active development, and as such certain features may be missing or not working as expected. If you find any issues, please raise it here.

We are also happy to help with installation and setting up your accelerator lattice.

API

• Framework
  • Framework
  • NumpySafeDumper
  • dict_constructor()
  • dict_representer()
  • frameworkDirectory
  • load_directory()
  • numpy_array_representer()
  • numpy_scalar_representer()
• Framework Objects
  • OUTPUT_LINE_SEPARATOR
  • OUTPUT_TURN_SEPARATOR
  • chicane
  • element_group
  • frameworkCommand
  • frameworkGroup
  • frameworkLattice
  • frameworkObject
  • getGrids
  • global_error
  • r56_group
  • runSetup
  • s_chicane
• Framework Elements
• simba package
  • Submodules
  • simba.exceptions module
  • simba.FrameworkHelperFunctions module
  • simba.Framework_Settings module
  • simba.Framework_lattices module
  • simba.yaml_checker module
  • Module contents
• simba.Codes package
  • Subpackages
  • Submodules
  • simba.Codes.Executables module
  • Module contents
• simba.Modules package
  • Subpackages
  • Submodules
  • simba.Modules.DeviceProgram module
  • simba.Modules.MathParser module
  • simba.Modules.SDDSFile module
  • simba.Modules.constants module
  • simba.Modules.gdf_beam module
  • simba.Modules.gdf_emit module
  • simba.Modules.units module
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page

References

[1]

K. Floettmann. ASTRA. https://www.desy.de/ mpyflo/. URL: https://www.desy.de/~mpyflo/.

[2]

Pulsar Physics. General Particle Tracer. www.pulsar.nl/gpt. URL: http://www.pulsar.nl/gpt.

[3]

M. Borland. Elegant: A flexible SDDS-compliant code for accelerator simulation. Proceedings of ICAP'00, Darmstadt, Germany, 2000. URL: https://www1.aps.anl.gov/icms_files/lsnotes/files/APS_1418218.pdf.

[4]

M. Dohlus and T. Limberg. CSRtrack : Faster Calculation of 3-D CSR Effects. Proceedings of FEL 2004, Trieste, Italy, pages MOCOS05, 2004. URL: https://accelconf.web.cern.ch/f04/papers/MOCOS05/MOCOS05.PDF.

[5]

I. Agapov, G. Geloni, S. Tomin, and I. Zagorodnov. Ocelot: A software framework for synchrotron light source and FEL studies. Nucl. Instrum. Meth. A, 768:151–156, 2014. URL: https://www.sciencedirect.com/science/article/pii/S0168900214010882, doi:https://doi.org/10.1016/j.nima.2014.09.057.

[6]

J. Kaiser, C. Xu, A. Eichler, and A. Santamaria Garcia. Bridging the gap between machine learning and particle accelerator physics with high-speed, differentiable simulations. Phys. Rev. Accel. Beams, 27:054601, May 2024. URL: https://link.aps.org/doi/10.1103/PhysRevAccelBeams.27.054601, doi:10.1103/PhysRevAccelBeams.27.054601.

[7]

G. Iadarola, A. Abramov, X. Buffat, R. De Maria, D. Demetriadou, L. Deniau, P.D. Hermes, P. Kicsiny, P. M. Kruyt, A. Latina, S. Łopaciuk, L. Mether, K. Paraschou, T. Pieloni, G. Sterbini, F.F. Van der Veken, P. Belanger, D. Di Croce, M. Seidel, and L. van Riesen-Haupt. Xsuite: an integrated beam physics simulation framework. Proceedings of ICFA 68th Advanced Beam Dynamics Workshop on High-Intensity and High-Brightness Hadron Beams, pages TUA2I1, 2023. URL: https://proceedings.jacow.org/hb2023/papers/tua2i1.pdf, doi:10.18429/JACoW-HB2023-TUA2I1.

[8]

A Ferran Pousa, R Assmann, and A Martinez de la Ossa. Wake-t: a fast particle tracking code for plasma-based accelerators. Journal of Physics: Conference Series, 1350(1):012056, Nov 2019. URL: https://dx.doi.org/10.1088/1742-6596/1350/1/012056, doi:10.1088/1742-6596/1350/1/012056.

[9]

D. Angal-Kalinin, A. Bainbridge, A. D. Brynes, R. K. Buckley, S. R. Buckley, G. C. Burt, R. J. Cash, H. M. Castaneda Cortes, D. Christie, J. A. Clarke, R. Clarke, L. S. Cowie, P. A. Corlett, G. Cox, K. D. Dumbell, D. J. Dunning, B. D. Fell, K. Gleave, P. Goudket, A. R. Goulden, S. A. Griffiths, M. D. Hancock, A. Hannah, T. Hartnett, P. W. Heath, J. R. Henderson, C. Hill, P. Hindley, C. Hodgkinson, P. Hornickel, F. Jackson, J. K. Jones, T. J. Jones, N. Joshi, M. King, S. H. Kinder, N. J. Knowles, H. Kockelbergh, K. Marinov, S. L. Mathisen, J. W. McKenzie, K. J. Middleman, B. L. Militsyn, A. Moss, B. D. Muratori, T. C. Q. Noakes, W. Okell, A. Oates, T. H. Pacey, V. V. Paramanov, M. D. Roper, Y. Saveliev, D. J. Scott, B. J. A. Shepherd, R. J. Smith, W. Smith, E. W. Snedden, N. R. Thompson, C. Tollervey, R. Valizadeh, A. Vick, D. A. Walsh, T. Weston, A. E. Wheelhouse, P. H. Williams, J. T. G. Wilson, and A. Wolski. Design, specifications, and first beam measurements of the compact linear accelerator for research and applications front end. Phys. Rev. Accel. Beams, 23:044801, Apr 2020. URL: https://link.aps.org/doi/10.1103/PhysRevAccelBeams.23.044801, doi:10.1103/PhysRevAccelBeams.23.044801.

[10]

E. W. Snedden, D. Angal-Kalinin, A. R. Bainbridge, A. D. Brynes, S. R. Buckley, D. J. Dunning, J. R. Henderson, J. K. Jones, K. J. Middleman, T. J. Overton, T. H. Pacey, A. E. Pollard, Y. M. Saveliev, B. J. A. Shepherd, P. H. Williams, M. I. Colling, B. D. Fell, and G. Marshall. Specification and design for full energy beam exploitation of the compact linear accelerator for research and applications. Phys. Rev. Accel. Beams, 27:041602, Apr 2024. URL: https://link.aps.org/doi/10.1103/PhysRevAccelBeams.27.041602, doi:10.1103/PhysRevAccelBeams.27.041602.