ops_data_client
===============

.. py:module:: ops_data_client

.. autoapi-nested-parse::

   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
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ops_data_client/retrieval/index
   /autoapi/ops_data_client/search/index
   /autoapi/ops_data_client/terminal/index
   /autoapi/ops_data_client/timing/index
   /autoapi/ops_data_client/utilities/index


Functions
---------

.. autoapisummary::

   ops_data_client.get_data


Package Contents
----------------

.. py:function:: 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

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

   :param pvs: List of PV names
   :type pvs: list
   :param number: number of records to retrieve
   :type number: int
   :param start: start of time range
   :type start: pd.Timestamp
   :param end: end of time range
   :type end: pd.Timestamp
   :param time_range_seconds: (float): search time range
   :param arch_processor_name: name of pre-processor to use in Archiver
   :type arch_processor_name: str
   :param arch_processor_bin_size: bin size for certain pre-processors
   :type arch_processor_bin_size: int
   :param config_file: the config file name path
   :type config_file: str

   :returns: final output containing all found datasets
   :rtype: dataframe_total (polars dataframe)