pyaml.magnet.quadrupole#

Quadrupole magnet elements.

This module defines normal quadrupole configuration and runtime interfaces.

Classes

Quadrupole(name[, model, lattice_names, ...])

Normal quadrupole magnet element.
class pyaml.magnet.quadrupole.Quadrupole(name, model=None, lattice_names=None, description=None)#

Bases: Magnet, DynamicValidation

Normal quadrupole magnet element.

The strength is applied to the PolynomB[1] component of the underlying lattice element, the field component used for focusing or defocusing the beam. Strengths are expressed in m-1 and converted to power-converter values by the attached magnet model.

Parameters:

  • name (str) – Element name.

  • model (MagnetModel | None, optional) – Magnet model used to convert between strength and hardware value, and to resolve the underlying control-system device names.

  • lattice_names (str | None, optional) – Name or names of the matching element(s) in the simulated lattice. Defaults to name.

  • description (str | None, optional) – Human-readable description of the magnet.

See also

Magnet

Base class listing the strength and hardware accessors.

Configuration

The model can be defined inline or in a separate file. See pyaml.magnet.model and its subclasses for model configuration.

- type: pyaml.magnet.quadrupole
  name: QUADRUPOLE_NAME
  lattice_names: LATTICE_QUADRUPOLE_NAME
  model: path/to/magnet_model.yaml
On this page