hydromt_fiat.workflows.vulnerability_curves#

hydromt_fiat.workflows.vulnerability_curves(vulnerability_data: DataFrame, vulnerability_linking: DataFrame | None = None, *, unit: str = 'm', index_name: str = 'water depth', column_oriented: bool = True, **select: dict[str, Any]) → tuple[DataFrame, DataFrame][source]#

Create vulnerability curves from raw data.

Warning

If not default exposure type is present in the vulnerability linking, the default exposure type is assumed to be ‘damage’.

Parameters:

  • vulnerability_data (pd.DataFrame) – The raw vulnerability dataset.

  • vulnerability_linking (pd.DataFrame, optional) – The vulnerability linking table, by default None.

  • unit (str, optional) – The unit of the vulnerability dataset index, by default “m”.

  • index_name (str, optional) – The name of the outgoing vulnerability curves dataset index, by default “water depth”.

  • column_oriented (bool, optional) – Whether the vulnerability data is column oriented, i.e. the values of a curve are in the same column spanning multiple rows. If False, the values are ought to be in the same row spanning multiple columns. By default True.

  • **select (dict, optional) – Keyword arguments to select data from ‘vulnerability_data’.

Returns:

A tuple containing the the vulnerability curves and updated link table.

Return type:

tuple[pd.DataFrame]