ophyd-async

Asynchronous Bluesky hardware abstraction code, compatible with control systems like EPICS and Tango

Source	bluesky/ophyd-async
PyPI	pip install ophyd-async
Documentation	https://bluesky.github.io/ophyd-async
Releases	bluesky/ophyd-async

Ophyd-async is a Python library for asynchronously interfacing with hardware, intended to be used as an abstraction layer that enables experiment orchestration and data acquisition code to operate above the specifics of particular devices and control systems.

Both ophyd and ophyd-async are typically used with the Bluesky Run Engine for experiment orchestration and data acquisition.

While EPICS is the most common control system layer that ophyd-async can interface with, support for other control systems like Tango will be supported in the future. The focus of ophyd-async is:

• Asynchronous signal access, opening the possibility for hardware-triggered scanning (also known as fly-scanning)

• Simpler instantiation of devices (groupings of signals) with less reliance upon complex class hierarchies

How the documentation is structured

Documentation is split into four categories, also accessible from links in the top bar.

• Tutorials
  • Installation
  • Using existing Devices

Tutorials for installation and typical usage. New users start here.

• How-to Guides
  • Decision Flowchart for Creating a New ophyd_async Device
  • Compound Devices Together
  • Contribute to the project
  • Make a Simple Device
  • Make a StandardDetector
  • Write Tests for Devices

Practical step-by-step guides for the more experienced user.

• Explanations
  • Architectural Decision Records
  • Design Goals
  • Device Collector Event-Loop Choice
  • Flyscanning

Explanations of how it works and why it works that way.

• Reference
  • API
  • Index
  • Release Notes

Technical reference material including APIs and release notes.