atomiq.components

Submodules

• atomiq.components.basics
• atomiq.components.coil
• atomiq.components.dummies
• atomiq.components.electronics
• atomiq.components.laser
• atomiq.components.lock
• atomiq.components.optimizers
• atomiq.components.optoelectronics
• atomiq.components.primitives
• atomiq.components.sinara

Attributes

heros
RemoteHERO
logger
components
suservo_replacements

Classes

Component	An atomiq Component
Remote
ComponentFactory

Functions

get_class_by_name(name[, relative_path])	Resolve class by name
_create_device_replace(desc, device_mgr, *args, **kwargs)
build_object_from_device_db(parent, object_id)
build_object_hero(parent, object_id)
build_object(classname, arg_dict)

Package Contents

atomiq.components.get_class_by_name(name, relative_path=None)

Resolve class by name

Parameters:

name -- (str) "%s.%s" % (module.name, class.name)

Returns:

(class)

class atomiq.components.Component(parent, identifier, debug_output=False, *args, **kwargs)

Bases: artiq.language.environment.HasEnvironment

An atomiq Component

Every component in atomiq inherits from this class. It provides basic functionality for automatic and recursive building and initialization of components (prepare, build, prerun). It also takes care for joining kernel invariants along the inheritance tree.

Note

The arguments parent and identifier are automatically passed to the component object by the atomiq object builder.

Parameters:

• parent -- The parent context of the component. Usually this is the experiment that uses the component

• identifier (artiq.language.types.TStr) -- A unique name to identify the component.

• debug_output (artiq.language.types.TBool) -- Set whether the component should show debug output. Using this switch rather than the debug kernel logger can allow the compiler to not include the debug commands in the kernel code if the output is not needed.

kernel_invariants

experiment

identifier

debug_output = False

core

_kernel_invariants

_prepare_done = False

_build_done = False

_hooks_done = []

_recursive_prepare()

_prepare()

Specify here what should be done for this component in the prepare phase

_recursive_build()

_build()

Specify here what should be done for this component in the build phase

_do_prerun()

required_components(ancestors=[])

_prerun()

Specify here what should be done for this component before the run starts. In contrast to the _build() method, the _prerun() routine is executed on the core device before the actual experiment starts.

class atomiq.components.Remote(remote_reference, sync=False)

Parameters:

• remote_reference (str)

• sync (bool)

remote_reference

sync = False

atomiq.components.heros

atomiq.components.RemoteHERO

atomiq.components.logger

atomiq.components.components = None

atomiq.components.suservo_replacements = []

atomiq.components._create_device_replace(desc, device_mgr, *args, **kwargs)

atomiq.components.build_object_from_device_db(parent, object_id)

atomiq.components.build_object_hero(parent, object_id)

atomiq.components.build_object(classname, arg_dict)

class atomiq.components.ComponentFactory

static produce(name, parent)

static _produce_from_dict(identifier, parent, dictionary)