Utilities

The utilities module provides helper functions and tools for working with Bluesky data acquisition systems.

aps_functions	APS utility helper functions
config_loaders	Configuration management for the instrument.
controls_setup	EPICS & ophyd related setup
helper_functions	Generic utility helper functions
logging_setup	Configure logging for this session.
metadata	RunEngine Metadata
stored_dict	Storage-backed Dictionary A dictionary that writes its contents to YAML file. Replaces bluesky.utils.PersistentDict. * Contents must be JSON serializable. * Contents stored in a single human-readable YAML file. * Sync to disk shortly after dictionary is updated. .. autosummary: :9: (ERROR/3) Unexpected indentation. ~StoredDict

These utilities help with:

1. Loading and managing configuration files

2. Setting up logging

3. Managing device metadata

4. Interfacing with APS-specific functionality

5. Creating and managing device configurations

Example Usage

Here’s how to use some of the utility functions:

from apsbits.utils import config_loaders, logging_setup, metadata

# Load configuration from YAML
config = config_loaders.load_yaml_config('config.yml')

# Set up logging
logger = logging_setup.setup_logger('my_logger')

# Store metadata
md = metadata.get_metadata()

API Reference

Local utilties and miscellaneous code.