gravitools.config

read_config(path)

Read a YAML config file

Parameters:

• path (str | Path) –

  Path to a YAML config file.

Returns:

• dict –

  Dictionary of configuration parameters.

select_date_config(config, date)

Select configuration parameters for a measurement date

Expects a dictionary of configuration parameters (config) that apply generally or are time-dependent. Time-dependent parameters should be grouped in a sub-dictionary with a key that denotes the starting date (identified by is_date()).

For example:

{
    'parameter1': 1,
    'parameter2': 2,
    '2020-01-01': {
        'parameter1: 2,
    },
    datetime.date(2021, 1, 1): {
        'parameter1: 3,
    },
}

Returns a merged dictionary of parameters that apply for the given date.

Parameters:

• config (dict) –

  Configuration parameters.

• date (str | Timestamp) –

  Measurement date.

Returns:

• dict –

  Dictionary of configuration parameters.

Examples:

>>> select_date_config({'x': 1, 'y': 2, '2020-01-01': {'x': 2}}, '2020-01-02')
{'x': 2, 'y': 2}

combine_dataset_config(config, dataset=None, meter=None, point=None, date=None)

Select configuration parameters for given dataset identifiers

Parameters:

• config (dict) –

  Complete configuration parameters.

• dataset (str, default: None ) –

  Dataset identifier name.

• meter (str, default: None ) –

  Meter identifier.

• point (str, default: None ) –

  Point identifier.

• date (str, default: None ) –

  Measurement date.

Returns:

• dict –

  Configuration parameters specific to this dataset.