ibex_bluesky_core.callbacks.file_logger

Creates a readable .txt file of Bluesky runengine dataset.

Members

HumanReadableFileCallback

Outputs bluesky runs to human-readable output files in the specified directory path.

class ibex_bluesky_core.callbacks.file_logger.HumanReadableFileCallback(fields: list[str], *, output_dir: Path | None, postfix: str = '')

Bases: CallbackBase

Outputs bluesky runs to human-readable output files in the specified directory path.

Output human-readable output files of bluesky runs.

If fields are given, just output those, otherwise output all hinted signals.

Parameters:

• fields – a list of field names to include in output files

• output_dir – filepath into which to write output files

• postfix – optional postfix to append to output file names

descriptor(doc: EventDescriptor) → None

Add the descriptor data to descriptors.

event(doc: Event) → Event

Append an event’s output to the file.

start(doc: RunStart) → None

Start writing an output file.

This involves creating the file if it doesn’t already exist then putting the metadata ie. start time, uid in the header.

stop(doc: RunStop) → RunStop | None

Clear descriptors.