README.md

blueapi

Lightweight bluesky-as-a-service wrapper application. Also usable as a library.

<<<<<<< before updating Source | https://github.com/DiamondLightSource/blueapi

This is where you should write a short paragraph that describes what your module does, how it does it, and why people should use it.

What | Where

after updating :---: | :---: Source | https://github.com/DiamondLightSource/blueapi PyPI | pip install blueapi Docker | docker run ghcr.io/diamondlightsource/blueapi:latest Documentation | https://diamondlightsource.github.io/blueapi Releases | https://github.com/DiamondLightSource/blueapi/releases

This module wraps bluesky plans and devices inside a server and exposes endpoints to send commands/receive data. Useful for installation at labs where multiple people may control equipment, possibly from remote locations.

The main premise of blueapi is to minimize the boilerplate required to get plans and devices up and running by generating an API for your lab out of type-annotated plans. For example, take the following plan:

import bluesky.plans as bp
from blueapi.core import MsgGenerator

def my_plan(foo: str, bar: int) -> MsgGenerator:
    yield from bp.scan(...)

Blueapi's job is to detect this plan and automatically add it to the lab's API so it can be invoked easily with a few REST calls.

See https://diamondlightsource.github.io/blueapi for more detailed documentation.