physrisk.risk_models

Submodules

physrisk.risk_models.loss_model

class physrisk.risk_models.loss_model.Aggregator

Bases: ABC

abstract get_aggregation_keys(asset: Asset, impact: ImpactDistrib) → List
class physrisk.risk_models.loss_model.DefaultAggregator

Bases: Aggregator

get_aggregation_keys(asset: Asset, impact: ImpactDistrib) → List
class physrisk.risk_models.loss_model.LossModel(hazard_model: HazardModel | None = None, vulnerability_models: VulnerabilityModels | None = None)

Bases: object

get_financial_impacts(assets: Sequence[Asset], *, financial_model: DefaultFinancialModel, scenario: str, year: int, aggregator: Aggregator | None = None, currency: str = 'EUR', sims: int = 100000)
uncorrelated_samples(impact: ImpactDistrib, samples: int, generator: Generator) → ndarray

physrisk.risk_models.risk_models

class physrisk.risk_models.risk_models.Threshold(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: int, Enum

ABS_HIGH = 0
ABS_LOW = 1
CHANGE = 2
class physrisk.risk_models.risk_models.RealEstateToyRiskMeasures

Bases: RiskMeasureCalculator

Toy model for calculating risk measures for real estate assets.

calc_measure(hazard_type: Type[Hazard], base_impacts: Sequence[AssetImpactResult], impacts: Sequence[AssetImpactResult]) → Measure

Calculate the Measure (score-based risk measure) for the hazard, given the set of base (i.e. historical) and future asset-level impacts. Most often there may be a single impact for a given type of hazard, but in general there can be multiple corresponding to different vulnerability models.

Parameters:

  • hazard_type (Type[Hazard]) – Hazard type.

  • base_impacts (Sequence[AssetImpactResult]) – Historical asset-level impacts.

  • impacts (Sequence[AssetImpactResult]) – Future asset-level impacts. The historical

  • model (and future impacts are aligned by the generating vulnerability)

  • required. (allowing these to be zipped and compared as)

Returns:

Single score-based risk measures, or a dictionary of score-based risk measures keyed by a hazard indicator ID, for cases where drill-down by hazard indicator is desired.

Return type:

Measure | dict[str, Measure]

calc_measure_acute(hazard_type: type, base_impact: ImpactDistrib, impact: ImpactDistrib) → Measure
calc_measure_cooling(hazard_type: type, base_impact: ImpactDistrib, impact: ImpactDistrib) → Measure
get_definition(hazard_type: type[Hazard], hazard_indicator_id: str | None = None) → ScoreBasedRiskMeasureDefinition
supported_hazards() → Set[type]

Module contents