oasislmf.preparation.correlations

Defines the functions that maps the supported perils with the correlation settings. This data is usually obtained from the model_settings.

Functions

map_data(→ Optional[pandas.DataFrame])

Maps data from the model settings to to have Peril ID, peril_correlation_group, and damage_correlation_value.

Module Contents

oasislmf.preparation.correlations.map_data(data: dict | None, logger) → pandas.DataFrame | None[source]

Maps data from the model settings to to have Peril ID, peril_correlation_group, and damage_correlation_value.

Parameters:

  • data – (dict) the data loaded from the model settings

  • logger – logger used to warn when the model settings hold no correlation data

Returns: (pd.DataFrame) the mapped data