Mondaic
This API reference is not for the latest stable Salvus version.

salvus.flow.collections.data_proxies

Concrete data proxy implementations.

Classes

BaseDataProxy

class BaseDataProxy(builtins.object):
    def __init__(self, config: Dict):
        ...

Init.

Parameters
  • config Dict — The configuration dictionary.
Attributes
config_schema voluptuous.schema_builder.Schema

Schema the configuration must adhere to. Must be set by child classes.

name str

Name of the data proxy. Must be set.

Methods
compute_hash()
def compute_hash(self) -> str:
    ...

Compute a hash to uniquely identify the data proxy. Must be fast as will potentially be called quite a bit.

Returns str
get_data()
def get_data(self, event_name: str) -> xarray.core.dataset.Dataset:
    ...

Main function of the data proxy returning an xarray dataset for any event.

Parameters
  • event_name str — The name of the event.
Returns xarray.core.dataset.Dataset

Submodules