Beamlines

Beamline objects are the central hub of all devices devices and provide a convenient configuration mechanism for defining component devices.

class mxdc.beamlines.Beamline(console=False)

Base class for all Beamline objects

Initializes a Beamline object from a python configuration file. The devices defined in the configuration file can be accessed by name as attributes of the beamline.

Parameters

console – if True, initialize console devices as well

The configuration file is loaded as a python module and follows the following conventions:

• Optionally will also load a local module defined in the file <config-module>_local.py for the above example.

• Global Variables:

Signals

• ready: (bool,)

Attributes

• DEFAULTS: dict, default config values for the beamline

• REQUIRED: list of required device names. All devices on this list must be defined in the config file.

cleanup()

Cleanup devices which can be cleaned up

is_admin()

Check if the current user is an administrator

is_ready()

Check if beamline is ready

load_config()

Read the configuration file and register all devices. You should not need to call this method directly.

setup()

Additional setup tasks should be defined here. This is run after the configuration is loaded and all devices and services have been added to the registry