Framework Modules package

Simframe Modules

Modules to handle particle beams, electromagnetic fields, matrices, plotting, optimisation and Twiss parameters, along with various utility functions.

Classes:

• beam: Handles particle distributions, including

various analysis functions and the loading and writing of files to and from various formats.

• field: Handles electromagnetic field distributions,

including the loading and writing of files to and from various formats.

• matrices: Handles particle tracking matrices of

various orders.

• twiss: Handles beam twiss parameters produced by

simulations and joins them together.

• optimiser: Generic optimiser class.

• UnitValue: Class for storing arrays, floats and integers

with units attached; used in many of these modules.

Other classes are defined in this submodule, but most of them are for expert use only.