Version:

salvus.flow.collections.data_proxies

salvus.flow.collections.data_proxies salvus flow collections data_proxies
Concrete data proxy implementations.

Classes

BaseDataProxy

Helper class that provides a standard way to create an ABC using inheritance.
Init.
SIGNATURE
class BaseDataProxy(abc.ABC):
    def __init__(self, config: dict): ...
ARGUMENTS
Required
config
Type:dict
Description:
The configuration dictionary.

Properties

  • config_schema(voluptuous.Schema)-Schema the configuration must adhere to. Must be set by child classes.
  • name(str)-Name of the data proxy. Must be set.

Methods

BaseDataProxy.compute_hash()
Compute a hash to uniquely identify the data proxy. Must be fast as will potentially be called quite a bit.
SIGNATURE
def compute_hash(self) -> str: ...
BaseDataProxy.get_data()
Main function of the data proxy returning an xarray dataset for any event.
SIGNATURE
def get_data(self, event_name: str) -> xr.Dataset: ...
ARGUMENTS
Required
event_name
Type:str
Description:
The event name.

Submodules

PAGE CONTENTS