climada_petals.entity.impact_funcs package

climada_petals.entity.impact_funcs.drought module

class climada_petals.entity.impact_funcs.drought.ImpfDrought

Bases: ImpactFunc

Impact function for droughts.

__init__()

Empty initialization.

Parameters:

• impf_id (int, optional) – impact function id. Default: 1

• intensity (np.array, optional) – intensity array SPEI [-]. default: intensity defintion 1 (minimum) default_sum: intensity definition 3 (sum over all drought months)

Raises:

ValueError –

set_default(*args, **kwargs)

This function is deprecated, use ImpfDrought.from_default instead.

set_default_sum(*args, **kwargs)

This function is deprecated, use ImpfDrought.from_default_sum instead.

set_default_sumthr(*args, **kwargs)

This function is deprecated, use ImpfDrought.from_default_sumthr instead.

set_step(*args, **kwargs)

This function is deprecated, use ImpfDrought.from_step instead.

classmethod from_default()

Returns:

impf – Default impact function.

Return type:

ImpfDrought

classmethod from_default_sum()

Returns:

impf – Default sum impact function.

Return type:

ImpfDrought

classmethod from_default_sumthr()

Returns:

impf – Default sum threshold impact function.

Return type:

ImpfDrought

classmethod from_step()

Returns:

impf – step impact function.

Return type:

ImpfDrought

climada_petals.entity.impact_funcs.drought.IFDrought()

Is ImpfDrought now

Deprecated since version The: class name IFDrought is deprecated and won’t be supported in a future version. Use ImpfDrought instead

climada_petals.entity.impact_funcs.relative_cropyield module

class climada_petals.entity.impact_funcs.relative_cropyield.ImpfRelativeCropyield

Bases: ImpactFunc

Impact functions for agricultural droughts.

__init__()

Initialization.

Parameters:

• haz_type (str, optional) – Hazard type acronym (e.g. ‘TC’).

• id (int or str, optional) – id of the impact function. Exposures of the same type will refer to the same impact function id.

• intensity (np.array, optional) – Intensity values. Defaults to empty array.

• mdd (np.array, optional) – Mean damage (impact) degree for each intensity (numbers in [0,1]). Defaults to empty array.

• paa (np.array, optional) – Percentage of affected assets (exposures) for each intensity (numbers in [0,1]). Defaults to empty array.

• intensity_unit (str, optional) – Unit of the intensity.

• name (str, optional) – Name of the ImpactFunc.

set_relativeyield(*args, **kwargs)

This function is deprecated, use ImpfRelativeCropyield.impf_relativeyield instead.

classmethod impf_relativeyield()

Impact functions defining the impact as intensity

Returns:

impf

Return type:

climada.entity.impact_funcs.ImpfRelativeCropyield instance

climada_petals.entity.impact_funcs.relative_cropyield.IFRelativeCropyield()

Is ImpfRelativeCropyield now

Deprecated since version The: class name IFRelativeCropyield is deprecated and won’t be supportedin a future version. Use ImpfRelativeCropyield instead

climada_petals.entity.impact_funcs.river_flood module

class climada_petals.entity.impact_funcs.river_flood.ImpfRiverFlood

Bases: ImpactFunc

Impact functions for tropical cyclones.

__init__()

Initialization.

Parameters:

• haz_type (str, optional) – Hazard type acronym (e.g. ‘TC’).

• id (int or str, optional) – id of the impact function. Exposures of the same type will refer to the same impact function id.

• intensity (np.array, optional) – Intensity values. Defaults to empty array.

• mdd (np.array, optional) – Mean damage (impact) degree for each intensity (numbers in [0,1]). Defaults to empty array.

• paa (np.array, optional) – Percentage of affected assets (exposures) for each intensity (numbers in [0,1]). Defaults to empty array.

• intensity_unit (str, optional) – Unit of the intensity.

• name (str, optional) – Name of the ImpactFunc.

classmethod from_jrc_region_sector(region, sector='residential')

Create a new ImpfRiverFlood object based on the specified world region and sector. Impact functions come from the following JRC publication:

Huizinga, J., De Moel, H. and Szewczyk, W., Global flood depth-damage functions: Methodology and the database with guidelines, EUR 28552 EN, Publications Office of the European Union, Luxembourg, 2017, ISBN 978-92-79-67781-6, doi:10.2760/16510, JRC105688.

Notes

The impact functions assess percentage losses at 0, 0.5, 1, 1.5, 2, 3, 4, 5, 6 meters of water. For North America, percentage losses higher than 0 are already registerd at 0 meters of water, because it accounts for the presence of basements (see main publication). Since this could be problematic when computing impacts, as one would have losses also when there is no flood, a 0.05 meters of water point is added to all functions (not only North America, for consistency), and this corresponds to the 0 meters point in the JRC functions.

Parameters:

• region (str) – world region for which the impact function was defined. Supported values:

• “Africa”, “Asia”, “Europe”, “North America”, “Oceania”, “South America”.

• sector (str) – sector for which the impact function was defined. Supported values: “residential”, “commercial”, “industrial”, “transport”, “infrastructure”, “agriculture”.

Returns:

impf – New ImpfRiverFlood object with parameters for the specified world region and sector.

Return type:

ImpfRiverFlood

Raises:

ValueError –

set_RF_Impf_Africa(*args, **kwargs)

This function is deprecated, use ImpfRiverFlood.from_region_sector instead.

set_RF_Impf_Asia(*args, **kwargs)

This function is deprecated, use ImpfRiverFlood.from_region_sector instead.

set_RF_Impf_Europe(*args, **kwargs)

This function is deprecated, use ImpfRiverFlood.from_region_sector instead.

set_RF_Impf_NorthAmerica(*args, **kwargs)

This function is deprecated, use ImpfRiverFlood.from_region_sector instead.

set_RF_Impf_Oceania(*args, **kwargs)

This function is deprecated, use ImpfRiverFlood.from_region_sector instead.

set_RF_Impf_SouthAmerica(*args, **kwargs)

This function is deprecated, use ImpfRiverFlood.from_region_sector instead.

climada_petals.entity.impact_funcs.river_flood.IFRiverFlood()

Is ImpfRiverFlood now

Deprecated since version The: class name IFRiverFlood is deprecated and won’t be supported in a future version. Use ImpfRiverFlood instead

climada_petals.entity.impact_funcs.wildfire module

class climada_petals.entity.impact_funcs.wildfire.ImpfWildfire(haz_type='WFsingle')

Bases: ImpactFunc

Impact function for wildfire.

__init__(haz_type='WFsingle')

Initialization.

Parameters:

• haz_type (str, optional) – Hazard type acronym (e.g. ‘TC’).

• id (int or str, optional) – id of the impact function. Exposures of the same type will refer to the same impact function id.

• intensity (np.array, optional) – Intensity values. Defaults to empty array.

• mdd (np.array, optional) – Mean damage (impact) degree for each intensity (numbers in [0,1]). Defaults to empty array.

• paa (np.array, optional) – Percentage of affected assets (exposures) for each intensity (numbers in [0,1]). Defaults to empty array.

• intensity_unit (str, optional) – Unit of the intensity.

• name (str, optional) – Name of the ImpactFunc.

classmethod from_default_FIRMS(i_half=295.01, impf_id=1)

This function sets the impact curve to a sigmoid type shape, as common in impact modelling. We adapted the function as proposed by Emanuel et al. (2011) which hinges on two parameters (intercept (i_thresh) and steepness (i_half) of the sigmoid).

\[f = \frac{i^{3}}{1+i^{3}}\]

with

\[i = \frac{MAX[(i_{lat, lon}-i_{thresh}), 0]}{i_{half}-i_{thresh}}\]

The intercept is defined at the minimum intensity of a FIRMS value (295K) which leaves the steepness (i_half) the only parameter that needs to be calibrated.

Here, i_half is set to 295 K as a result of the calibration performed by Lüthi et al. (in prep). This value is suited for an exposure resolution of 1 km.

Calibration was further performed for:

• 4 km: resulting i_half = 409.4 K

• 10 km: resulting i_half = 484.4 K

Calibration has been performed globally (using EMDAT data) and is based on 84 damage records since 2001.

Intensity range is set between 295 K and 500 K as this is the typical range of FIRMS intensities.

Parameters:

• i_half (float, optional, default = 295.01) – steepnes of the IF, [K] at which 50% of max. damage is expected

• if_id (int, optional, default = 1) – impact function id

Returns:

Impf

Return type:

climada.entity.impact_funcs.ImpfWildfire instance

set_default_FIRMS(*args, **kwargs)

This function is deprecated, use ImpfWildfire.from_default_FIRMS instead.