simulator#

class ConfigModel(*, name, lattice, mat_key=None, linker=None, description=None)[source]#

Bases: BaseModel

Configuration model for Simulator

Parameters:

  • name (str) – Simulator name

  • lattice (str) – AT lattice file

  • mat_key (str, optional) – AT lattice ring name

  • linker (LatticeElementsLinker, optional) – The linker configuration model

  • description (str , optional) – Simulator description

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

description: str | None#
lattice: str#
linker: LatticeElementsLinker#
mat_key: str#
name: str#
class Simulator(cfg)[source]#

Bases: ElementHolder

Class that implements access to AT simulator

create_bpm_aggregators(bpms)[source]#
create_magnet_hardware_aggregator(magnets)[source]#
create_magnet_strength_aggregator(magnets)[source]#
fill_device(elements)[source]#
get_at_elems(element)[source]#
get_description()[source]#

Returns the description of the accelerator

get_indices(element)[source]#

Parse element lattice_name syntax. see Element.ConfigModel.lattice_name.

get_lattice()[source]#
get_names(element)[source]#

Parse element lattice_name syntax. see Element.ConfigModel.lattice_name.

name()[source]#