Skip to main content
Ctrl+K
ophyd-async 0.17.dev1+gcc4f1d5d8 documentation - Home ophyd-async 0.17.dev1+gcc4f1d5d8 documentation - Home
  • Tutorials
  • How-to Guides
  • Explanations
  • Reference
  • Bluesky Project
  • GitHub
  • PyPI
  • Tutorials
  • How-to Guides
  • Explanations
  • Reference
  • Bluesky Project
  • GitHub
  • PyPI

Section Navigation

  • Architectural Decision Records
    • 1. Record architecture decisions
    • 2. Adopt python-copier-template for project structure
    • 3. Ophyd Async migration
    • 4. Repository Structure
    • 5. Respect black line length
    • 6. Procedural Device Definitions
    • 7. Sub-package Structure
    • 8. Settle on Signal Types
    • 9. Procedural vs Declarative Devices
    • 10. Decide on docstring format
    • 11. Buffer updates when using camonitor
    • 12. Rewrite StandardDetector with Composition-Based Logic
  • Declarative vs Procedural Devices
  • Design goals and differences with ophyd sync
  • Device connection strategies
  • Devices, Signals and their Backends
  • What is the difference between step and fly scanning
  • What plan stubs will do to Devices
  • When should a device extend movable
  • Where should Device logic live?
  • Explanations
  • Architectural Decision Records

Architectural Decision Records#

Architectural decisions are made throughout a project’s lifetime. As a way of keeping track of these decisions, we record these decisions in Architecture Decision Records (ADRs) listed below.

  • 1. Record architecture decisions
  • 2. Adopt python-copier-template for project structure
  • 3. Ophyd Async migration
  • 4. Repository Structure
  • 5. Respect black line length
  • 6. Procedural Device Definitions
  • 7. Sub-package Structure
  • 8. Settle on Signal Types
  • 9. Procedural vs Declarative Devices
  • 10. Decide on docstring format
  • 11. Buffer updates when using camonitor
  • 12. Rewrite StandardDetector with Composition-Based Logic

For more information on ADRs see this blog by Michael Nygard.

previous

Explanations

next

1. Record architecture decisions

Edit on GitHub

This Page

  • Show Source

Built with the PyData Sphinx Theme 0.16.1.