API#

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.

These command-line tools help with:

  1. Creating new instruments from templates

  2. Deleting instruments and their associated qserver configurations

  3. Running instruments and retrieving their ophyd registry information

Example Usage#

Create a new instrument:

create-bits --name my_instrument --path /path/to/instrument

Delete an instrument:

delete-bits --name my_instrument --path /path/to/instrument

Run an instrument:

run-bits --name my_instrument --path /path/to/instrument

API Reference#

API module for BITS.

This module provides command-line interfaces for creating, deleting, and running instruments in the BITS framework.