ops_data_client

This is a Python client for the ESS Operations Data Framework see ESS-5078677.

It allows Data Analysts to retrieve data from the different services in the Federated Storage. Currently this is limited to SDS and Archiver data.

Submodules

Functions

get_data() + ) → polars.DataFrame)

Get data for given PVs from the different sources, constrained by options.

Package Contents

ops_data_client.get_data(pvs: list[str], start: pandas.Timestamp | None = None, end: pandas.Timestamp | None = None, time_range_seconds: float = 5, number: int = 0, arch_processor_name: str = '', arch_processor_bin_size: int = 1, config_file: str = str(Path.home()) + '/.ops-config.ini') polars.DataFrame[source]

Get data for given PVs from the different sources, constrained by options.

Parameters:
  • pvs (list) – List of PV names

  • number (int) – number of records to retrieve

  • start (pd.Timestamp) – start of time range

  • end (pd.Timestamp) – end of time range

  • time_range_seconds – (float): search time range

  • arch_processor_name (str) – name of pre-processor to use in Archiver

  • arch_processor_bin_size (int) – bin size for certain pre-processors

  • config_file (str) – the config file name path

Returns:

final output containing all found datasets

Return type:

dataframe_total (polars dataframe)