Ophyd#

Build Status Test Coverage Latest PyPI version BSD 3-Clause License

Ophyd is Python library for interfacing with hardware. It provides an abstraction layer than enables experiment orchestration and data acquisition code to operate above the specifics of particular devices and control systems.

Ophyd is typically used with the Bluesky Run Engine for experiment orchestration and data acquisition. It is also sometimes used in a stand-alone fashion.

Many facilities use ophyd to integrate with control systems that use EPICS , but ophyd’s design and some of its objects are also used to integrate with other control systems.

  • Put the details specific to a device or control system behind a high-level interface with methods like trigger(), read(), and set(...).

  • Group individual control channels (such as EPICS V3 PVs) into logical “Devices” to be configured and used as units with internal coordination.

  • Assign readings with names meaningful for data analysis that will propagate into metadata.

  • Categorize readings by “kind” (primary reading, configuration, engineering/debugging) which can be read selectively.

PyPI

pip install ophyd

Conda

pip install -c nsls2forge ophyd

Source code

bluesky/ophyd

Documentation

https://blueskyproject.io/ophyd

See the tutorials for usage examples.

How the documentation is structured#

The documentation is split into 2 sections:

The User Guide v1 contains documentation on how to install and use ophyd’s original v1 API.

New users should use this API until v2 has stabilized.

The User Guide v2 contains documentation on how to use ophyd’s provisional v2 API.

Developers may use this to develop v2 Devices against, but the API is subject to change