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 acquistion. 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 coordiantion.

  • 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

https://github.com/bluesky/ophyd

Documentation

https://blueskyproject.io/ophyd

See the tutorials for usage examples.

How the documentation is structured

Tutorials

Tutorials for installation and usage. New users start here.

How-to Guides

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

Explanations

Explanation of how the library works and why it works that way.

Reference

Technically detailed API documentation.