epicsarchiver.retrieval.dataframe

Polars DataFrame utilities for archived events.

Requires the [polars] extra: pip install epicsarchiver-retrieval-client[polars]

Attributes

_FIELD_VALUE_DTYPE

Classes

_EventColumns

Functions

_fv_list(→ list[dict[str, str]])
dataframe_from_events(→ polars.DataFrame)	Converts a list of ArchiveEvent to pl.DataFrame.
json_to_dataframe(→ polars.DataFrame)	Converts json from the archiver.

Module Contents

epicsarchiver.retrieval.dataframe._FIELD_VALUE_DTYPE

epicsarchiver.retrieval.dataframe._fv_list(fvs: list[epicsarchiver.retrieval.archive_event.FieldValue] | None) → list[dict[str, str]]

class epicsarchiver.retrieval.dataframe._EventColumns

date: list[int]

pv: list[str]

val: list[Any]

severity: list[int]

status: list[int]

field_values: list[list[dict[str, str]]]

headers: list[list[dict[str, str]]]

static from_list(events: list[epicsarchiver.retrieval.archive_event.ArchiveEvent], metadata: dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta]) → _EventColumns

epicsarchiver.retrieval.dataframe.dataframe_from_events(events: list[epicsarchiver.retrieval.archive_event.ArchiveEvent], metadata: dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta] | None = None) → polars.DataFrame

Converts a list of ArchiveEvent to pl.DataFrame.

Parameters:

• events (list[ArchiveEvent]) – input events

• metadata (dict[int, ArchiveEventsMeta] | None) – optional per-year metadata; when provided, populates the “headers” column.

Returns:

columns “date”, “pv”, “val”, “severity”, “status”,

”field_values”, “headers”.

Return type:

pl.DataFrame

epicsarchiver.retrieval.dataframe.json_to_dataframe(data: Any) → polars.DataFrame

Converts json from the archiver.

Converts to a dataframe with columns “date”, “val”, and any other fields returned by the API (typically “severity”, “status”).

Parameters:

data – json from a json archiver request

Returns:

pl.DataFrame