oasislmf.preparation.correlations
=================================

.. py:module:: oasislmf.preparation.correlations

.. autoapi-nested-parse::

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



Functions
---------

.. autoapisummary::

   oasislmf.preparation.correlations.map_data


Module Contents
---------------

.. py:function:: map_data(data: Optional[dict], logger) -> Optional[pandas.DataFrame]

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

   Args:
       data: (dict) the data loaded from the model settings

   Returns: (pd.DataFrame) the mapped data