The Accelerator Simulation Framework

The Accelerator Simulation Framework otherwise known as SimFrame 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]

The primary use for SimFrame has been for simulating the CLARA particle accelerator [6] [7].

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-force
  • Required Dependencies
  • Optional Dependencies
• Getting started with SimFrame
  • Creating the Lattice Elements
  • Defining the Lattice Simulation
  • Running SimFrame
• MasterLattice
  • Required and default parameters
  • Building a lattice: A simple FODO example
• SimCodes
  • Creating a SimCodes Directory
  • Editing the Executables.yaml file
  • Pointing to a specific location
  • Citing the codes used

Examples

• Getting started with SimFrame
  • Preparing the simulation and tracking
• SimFrame 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! SimFrame 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 Objects
  • chicane
  • csrdrift
  • edrift
  • element_group
  • frameworkCommand
  • frameworkCounter
  • frameworkElement
  • frameworkGroup
  • frameworkLattice
  • frameworkObject
  • getGrids
  • has_symlink_privilege()
  • lscdrift
  • r56_group
  • runSetup
  • s_chicane
• Framework Elements
• Framework Codes
• Framework Modules package

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]

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.

[7]

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.