atef.procedure

Dataclasses for describing active checkout procedures. These dataclasses come in normal (edit) and Prepared (run) variants

Edit variants hold data needed to specify the step. Prepared variants hold a reference to their originating edit-step, along with Result objects and a .run() method.

Adding a step requires: - write the edit-variant - add the edit-variant to the AnyProcedure type hint - write the run-variant, along with its ._run() and .from_origin() methods - add the step to PreparedProcedure.from_origin classmethod case statement

Functions

create_prepared_comparison(check[, parent])
get_RE_data(bs_state, plan_data)	Get databroker data from the GlobalRunEngine from the plan specified by plan_data.
get_bs_state(dclass)	Get the BlueskyState instance corresponding to dclass.

Classes

CodeStep(name, description, parent, ...)	Run source code in a procedure.
ComparisonToPlanData(name, plan_id, plan_no, ...)	Attributes:
ComparisonToTarget([name, device, attr, pv, ...])	Attributes:
ConfigurationCheckStep(name, description, ...)	Step which checks device configuration versus a given timestamp.
DescriptionStep([name, description, parent, ...])	A simple title or descriptive step in the procedure.
DeviceConfiguration(archiver_timestamp, values)	Device configuration for comparison.
DisplayOptions(macros, str] =, template, embed)	Options for a typhos or PyDM display.
FailedStep(parent, origin, combined_result, ...)	A step that failed to be prepared for running.
PassiveStep(name, description, parent, ...)	A step that runs a passive checkout file
PlanData(name, plan_id, plan_no, ...)	Attributes:
PlanOptions(name, plan, args, kwargs, ...)	Options for a bluesky plan scan.
PlanStep(name, description, parent, ...)	A procedure step comprised of one or more bluesky plans.
PreparedDescriptionStep(name, origin, ...)	Attributes:
PreparedPassiveStep(name, origin, parent, ...)	Attributes:
PreparedPlan(name, origin, parent, item, ...)	Attributes:
PreparedPlanComparison(cache, identifier, ...)	Unified representation for comparisons to Bluesky Plan data
PreparedPlanStep(name, origin, parent, ...)	Attributes:
PreparedProcedureFile(file, root)	A Prepared Procedure file.
PreparedProcedureGroup(name, origin, parent, ...)	Attributes:
PreparedProcedureStep(name, origin, parent, ...)	Base class for a ProcedureStep that has been prepared to run.
PreparedSetValueStep(name, origin, parent, ...)	Attributes:
PreparedValueToSignal(name, signal, value, ...)	Attributes:
ProcedureFile(version, root)	File comprised of several Procedure steps
ProcedureGroup(name, description, parent, ...)	A group of procedure steps (or nested groups).
ProcedureStep([name, description, parent, ...])	A basic step in an atef procedure.
PydmDisplayStep(name, description, parent, ...)	A procedure step which a opens a PyDM display.
SetValueStep(name, description, parent, ...)	A step that sets one or more values and checks one or more values after
Target([name, device, attr, pv])	A destination for a value.
TyphosDisplayStep(name, description, parent, ...)	A procedure step which opens one or more typhos displays.
ValueToTarget([name, device, attr, pv, ...])	Attributes: