ARCHIVED: work has moved to https://github.com/bluesky/ophyd

ophyd

Ideas for ophyd v2, will be merged with bluesky/ophyd when ready

PyPI	pip install ophyd
Source code	https://github.com/dls-controls/ophyd
Documentation	https://dls-controls.github.io/ophyd
Releases	https://github.com/dls-controls/ophyd/releases

The main aims of this new version are:

• Split into Devices (containing PV interface) and Abilities (containing the logic)

• Make all Abilities async

• Provide useful helpers for flyscans

How the documentation is structured

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

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

Tutorials

• Installation
  • Check your version of python
  • Create a virtual environment
  • Installing the library

How-to Guides

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

How-to Guides

• How to accomplish a task

Explanations

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

Explanations

• Architectural Decision Records
  • 1. Record architecture decisions
    • Status
    • Context
    • Decision
    • Consequences
  • 2. Use ophyd.v2 namespace
    • Status
    • Context
    • Decision
    • Consequences
  • 3. Expose severity and message in read()
    • Status
    • Context
    • Decision
    • Consequences
  • 4. Where Do Devices Live
    • Status
    • Context
    • Decision
    • Consequences
  • 5. What to name things
    • Status
    • Context
    • Decision
    • Consequences

Reference

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

Reference

• API
  • ophyd
  • ophyd.v2
• Contributing
  • Running the tests
  • Code Styling
  • Documentation
  • Release Process
  • Updating the tools
• Releases
• Index

About the documentation

Why is the documentation structured this way?