Skip to main content

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

Project description

CI Coverage PyPI License

blueapi

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

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.

concept

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blueapi-0.6.2a2.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

blueapi-0.6.2a2-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

Details for the file blueapi-0.6.2a2.tar.gz.

File metadata

  • Download URL: blueapi-0.6.2a2.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for blueapi-0.6.2a2.tar.gz
Algorithm Hash digest
SHA256 5a7f444672a88e5bf4e30cd310a86e9913374229dab8404c50ff859bebe5e446
MD5 64049318f2a74902cc2907e7f0185464
BLAKE2b-256 7fc65735e706633dfb3ddbf0391e2f8eff13112465ad1acb91ce5bfe266cdbf1

See more details on using hashes here.

File details

Details for the file blueapi-0.6.2a2-py3-none-any.whl.

File metadata

  • Download URL: blueapi-0.6.2a2-py3-none-any.whl
  • Upload date:
  • Size: 61.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for blueapi-0.6.2a2-py3-none-any.whl
Algorithm Hash digest
SHA256 1630c3b950f4370f967b91744fa966e807c09375d5f2e6d4c9ae9947ee1b1a17
MD5 3b7a9511927b16471c0c269ea73b16ba
BLAKE2b-256 29514be016527d786df708aa02cfc048060b0852e744c7df78bf233cd2e05c17

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page