API Reference#

pyAML package

pyAML package#

pyAML

exception pyaml.PyAMLConfigException(message)#

Bases: Exception

Exception raised when configuration cannot be loaded or validated.

Parameters:: message (object) – Error description retained on the exception as message.

exception pyaml.PyAMLException(message)#

Bases: Exception

Base exception for errors raised by PyAML runtime components.

Parameters:: message (object) – Error description retained on the exception as message.

class pyaml.ReprOptions(max_items=3, max_depth=2, max_length=800)#

Bases: object

Limits applied to PyAML object representations.

pyaml.set_repr_options(max_items=None, max_depth=None, max_length=None)#

Configure the limits used by PyAML object representations.

Passing no arguments returns the current options. Every supplied value must be a positive integer.

Modules

`accelerator`	Accelerator class
`arrays`
`bpm`
`common`	PyAML common module Contains code common to both simulator and control system
`configuration`	PyAML configuration module
`control`	PyAML Control module Contains low level access to control system
`diagnostics`
`external`
`lattice`	PyAML Lattice module Provides access to simulator engine
`magnet`	PyAML Magnet module
`rf`	PyAML RF module
`tuning_tools`	tuning tools package
`validation`	PyAML validation subpackage.
`yellow_pages`	Dynamic discovery service for accelerator objects.