API: The Source Code

The APSBITS package provides tools and utilities to build Bluesky instruments. The package structure is:

docs/source         sphinx documentation source
pyproject.toml      project configuration
src/               Python source code tree
    apsbits/       root of the 'apsbits' package
        api/       command-line interfaces for instrument management
        core/      core components for Bluesky data acquisition
        utils/     utilities for setup and configuration
        demo_instrument/  example instrument implementation
            startup.py   setup a demo session for Bluesky data acquisition
            callbacks/  receive and handle info from other code
            configs/   configuration files
            devices/   demo instrument's controls
            plans/    demo instrument's measurement procedures
            suspenders/  suspender implementations
            utils/      utility functions and classes
        demo_qserver/   example queueserver implementation

A Bluesky data acquisition session using the demo instrument begins with:

from apsbits.demo_instrument.startup import *

The apsbits/ package is described in the following sections.

API Documentation

This section contains detailed API documentation for the APSBITS package.

• Core Components
  • apsbits.core.best_effort_init
  • apsbits.core.catalog_init
  • apsbits.core.run_engine_init
  • Example Usage
  • API Reference
• Utilities
  • apsbits.utils.aps_functions
  • apsbits.utils.config_loaders
  • apsbits.utils.controls_setup
  • apsbits.utils.helper_functions
  • apsbits.utils.logging_setup
  • apsbits.utils.metadata
  • apsbits.utils.stored_dict
  • Example Usage
  • API Reference
• Demo Instrument
  • apsbits.demo_instrument.startup
  • apsbits.demo_instrument.callbacks
  • apsbits.demo_instrument.devices
  • apsbits.demo_instrument.plans
  • Example Usage
  • Components
• Demo Queue Server
• Starting the Server
  • Configuration
• API
  • apsbits.api.create_new_instrument
  • apsbits.api.delete_instrument
  • apsbits.api.run_instrument
  • Example Usage
  • API Reference

Core Components

The core components provide the fundamental building blocks for Bluesky data acquisition:

apsbits.core.best_effort_init	BestEffortCallback: simple real-time visualizations, provides bec.
apsbits.core.catalog_init	Databroker catalog
apsbits.core.run_engine_init	Setup and initialize the Bluesky RunEngine.

Utilities

The utilities module provides helper functions and tools:

apsbits.utils.aps_functions	APS utility helper functions
apsbits.utils.config_loaders	Configuration management for the instrument.
apsbits.utils.controls_setup	EPICS & ophyd related setup
apsbits.utils.helper_functions	Generic utility helper functions
apsbits.utils.logging_setup	Configure logging for this session.
apsbits.utils.metadata	RunEngine Metadata
apsbits.utils.stored_dict	Storage-backed Dictionary

Demo Components

Example implementations and templates:

apsbits.demo_instrument	Demo instrument package.
apsbits.demo_qserver

Command-Line Interfaces

The API module provides command-line interfaces for instrument management:

apsbits.api.create_new_instrument	Create a new instrument from a fixed template.
apsbits.api.delete_instrument	Delete an instrument and its associated qserver configuration.
apsbits.api.run_instrument	Run an instrument's startup module and return the ophyd registry information.