pyaml.arrays.magnet#

Magnet module.

This module provides magnet functionality for the PyAML accelerator middle layer.

Classes

Magnet(name, elements)

MagnetArray configuration.
class pyaml.arrays.magnet.Magnet(name, elements)#

Bases: ArrayConfig, DynamicValidation

MagnetArray configuration.

Parameters:

  • name (str) – Name under which the array is registered and later looked up.

  • elements (list[str]) – Element name patterns making up the array: literal names, fnmatch wildcards, or re: regular expressions.

Methods

fill_array()

Fill the magnet array in the element holder.

Examples

A magnet array configuration can also be created by code using the following example:

from pyaml.arrays.magnet import Magnet,ConfigModel as MagnetArrayConfigModel
magArray = Magnet(
             MagnetArrayConfigModel(name="MyMags", elements=["mag1","mag2"])
           )
fill_array(holder)#

Fill the magnet array in the element holder.

Parameters:

holder (ElementHolder) – The element holder to populate with magnet array