Integrates risk trajectories within climada

climada/trajectories/__init__.py

@@ -0,0 +1,35 @@
+"""
+This file is part of CLIMADA.
+
+Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.
+
+CLIMADA is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free
+Software Foundation, version 3.
+
+CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with CLIMADA. If not, see <https://www.gnu.org/licenses/>.
+
+---
+
+This module implements risk trajectory objects which enable computation and
+possibly interpolation of risk metric over multiple dates.
+
+"""
+
+from .interpolated_trajectory import InterpolatedRiskTrajectory
+from .interpolation import AllLinearStrategy, ExponentialExposureStrategy
+from .snapshot import Snapshot
+from .static_trajectory import StaticRiskTrajectory
+
+__all__ = [
+    "InterpolatedRiskTrajectory",
+    "AllLinearStrategy",
+    "ExponentialExposureStrategy",
+    "Snapshot",
+    "StaticRiskTrajectory",
+]

climada/trajectories/constants.py

@@ -0,0 +1,55 @@
+"""
+This file is part of CLIMADA.
+
+Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.
+
+CLIMADA is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free
+Software Foundation, version 3.
+
+CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with CLIMADA. If not, see <https://www.gnu.org/licenses/>.
+
+---
+
+Define constants for trajectories module.
+"""
+
+DEFAULT_TIME_RESOLUTION = "Y"
+DATE_COL_NAME = "date"
+PERIOD_COL_NAME = "period"
+GROUP_COL_NAME = "group"
+GROUP_ID_COL_NAME = "group_id"
+MEASURE_COL_NAME = "measure"
+NO_MEASURE_VALUE = "no_measure"
+METRIC_COL_NAME = "metric"
+UNIT_COL_NAME = "unit"
+RISK_COL_NAME = "risk"
+COORD_ID_COL_NAME = "coord_id"
+
+DEFAULT_PERIOD_INDEX_NAME = "date"
+
+DEFAULT_RP = [20, 50, 100]
+"""Default return periods to use when computing return period impact estimates."""
+
+DEFAULT_ALLGROUP_NAME = "All"
+"""Default string to use to define the exposure subgroup containing all exposure points."""
+
+EAI_METRIC_NAME = "eai"
+AAI_METRIC_NAME = "aai"
+AAI_PER_GROUP_METRIC_NAME = "aai_per_group"
+CONTRIBUTIONS_METRIC_NAME = "risk_contributions"
+RETURN_PERIOD_METRIC_NAME = "return_periods"
+RP_VALUE_PREFIX = "rp"
+
+
+CONTRIBUTION_BASE_RISK_NAME = "base risk"
+CONTRIBUTION_TOTAL_RISK_NAME = "total risk"
+CONTRIBUTION_EXPOSURE_NAME = "exposure contribution"
+CONTRIBUTION_HAZARD_NAME = "hazard contribution"
+CONTRIBUTION_VULNERABILITY_NAME = "vulnerability contribution"
+CONTRIBUTION_INTERACTION_TERM_NAME = "interaction contribution"

climada/trajectories/impact_calc_strat.py

@@ -0,0 +1,137 @@
+"""
+This file is part of CLIMADA.
+
+Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.
+
+CLIMADA is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free
+Software Foundation, version 3.
+
+CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with CLIMADA. If not, see <https://www.gnu.org/licenses/>.
+
+---
+
+This modules implements the impact computation strategy objects for risk
+trajectories.
+
+"""
+
+from abc import ABC, abstractmethod
+
+from climada.engine.impact import Impact
+from climada.engine.impact_calc import ImpactCalc
+from climada.entity.exposures.base import Exposures
+from climada.entity.impact_funcs.impact_func_set import ImpactFuncSet
+from climada.hazard.base import Hazard
+
+__all__ = ["ImpactCalcComputation"]
+
+
+class ImpactComputationStrategy(ABC):
+    """
+    Interface for impact computation strategies.
+
+    This abstract class defines the contract for all concrete strategies
+    responsible for calculating and optionally modifying with a risk transfer,
+    the impact computation, based on a set of inputs (exposure, hazard, vulnerability).
+
+    It revolves around a `compute_impacts()` method that takes as arguments
+    the three dimensions of risk (exposure, hazard, vulnerability) and return an
+    Impact object.
+    """
+
+    @abstractmethod
+    def compute_impacts(
+        self,
+        exp: Exposures,
+        haz: Hazard,
+        vul: ImpactFuncSet,
+    ) -> Impact:
+        """
+        Calculates the total impact, including optional risk transfer application.
+
+        Parameters
+        ----------
+        exp : Exposures
+            The exposure data.
+        haz : Hazard
+            The hazard data (e.g., event intensity).
+        vul : ImpactFuncSet
+            The set of vulnerability functions.
+
+        Returns
+        -------
+        Impact
+            An object containing the computed total impact matrix and metrics.
+
+        See Also
+        --------
+        ImpactCalcComputation : The default implementation of this interface.
+        """
+        ...
+
+
+class ImpactCalcComputation(ImpactComputationStrategy):
+    r"""
+    Default impact computation strategy using the core engine of climada.
+
+    This strategy first calculates the raw impact using the standard
+    :class:`ImpactCalc` logic.
+
+    """
+
+    def compute_impacts(
+        self,
+        exp: Exposures,
+        haz: Hazard,
+        vul: ImpactFuncSet,
+    ) -> Impact:
+        """
+        Calculates the impact and applies the "global" risk transfer mechanism.
+
+        Parameters
+        ----------
+        exp : Exposures
+            The exposure data.
+        haz : Hazard
+            The hazard data.
+        vul : ImpactFuncSet
+            The set of vulnerability functions.
+
+        Returns
+        -------
+        Impact
+            The final impact object.
+        """
+        impact = self.compute_impacts_pre_transfer(exp, haz, vul)
+        return impact
+
+    def compute_impacts_pre_transfer(
+        self,
+        exp: Exposures,
+        haz: Hazard,
+        vul: ImpactFuncSet,
+    ) -> Impact:
+        """
+        Calculates the raw impact matrix before any risk transfer is applied.
+
+        Parameters
+        ----------
+        exp : Exposures
+            The exposure data.
+        haz : Hazard
+            The hazard data.
+        vul : ImpactFuncSet
+            The set of vulnerability functions.
+
+        Returns
+        -------
+        Impact
+            An Impact object containing the raw, pre-transfer impact matrix.
+        """
+        return ImpactCalc(exposures=exp, impfset=vul, hazard=haz).impact()