Module simpa.acc

Package simpa.acc.api

package simpa.acc.api

This package contains the public interfaces and classes of the simpa.acc library.

Related Packages

Package	Description
simpa.acc.api.create	This package contains all the interfaces and classes related to the creation and setting up of components to construct accelerators.
simpa.acc.api.match	This package contains all the interfaces and classes related to optics matching or any other optimization which is performed by tracking beams or particles.
simpa.acc.api.track	This package contains all the code specifically related to the tracking of particles in particle accelerators.
simpa.acc.api.utils	This package contains utility classes to help in using the simpa.acc module.

Class	Description
AccCli	Class that specifies all the commands that can be used in the CLI using the CLI library apart from some extra commands.
Beam
BeamDistribution
BendingType
BpmPlane
EllipseBeam	Special beam mainly for optics calculations.
FieldTypeOption
IntegratorTypeOption
LocalFrameStrategyOption
Optics	This class holds optics data calculated by the OpticsCalculator.
OutputFileFormatOption
ParticleFactory	Factory for creating particles from Phase space coordinate data.
PlotTypeOption	Plot type options used by the `plot` CLI command.
SolverPreset
TileTypeOption
Tune
TwissParameters	Record to hold the Twiss parameters.
TwissParameters.Builder