dodal

Ophyd devices and other utils that could be used across DLS beamlines

Source	DiamondLightSource/dodal
PyPI	pip install dls-dodal
Documentation	https://diamondlightsource.github.io/dodal
Releases	DiamondLightSource/dodal

Testing Connectivity

You can test your connection to a beamline if it’s PVs are visible to your machine with:

    # On any workstation:
    dodal connect <BEAMLINE>

    # On a beamline workstation, this should suffice:
    dodal connect ${BEAMLINE}

For more options, including a list of valid beamlines, type

    dodal connect --help

How the documentation is structured

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

• Tutorials
  • Getting Started
  • Installation

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

• How-to Guides
  • Build the docs using sphinx
  • Contribute to the project
  • How to check code coverage
  • Creating a new beamline
  • Setup Developer Environment
  • How to embed Excalidraw diagrams
  • Run linting using pre-commit
  • Lock requirements
  • Decision Flowchart for Creating a New ophyd_async Device
  • Make a release
  • Moving code from another repo
  • Setting up PyPI publishing
  • Run the tests using pytest
  • Run static analysis using pyright or mypy
  • How to update to the latest template structure
  • Writing Tests in This Python Project
  • Zocalo Interaction

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

• Explanations
  • Architectural Decision Records

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

• Reference
  • API
  • Index
  • Release Notes

Technical reference material including APIs and release notes.