Merge pull request #1274 from CLIMADA-project/feature/option-appraisal-split-make-legacy

spjuhel · web-flow · commit 3133447ad655 · 2026-05-13T14:24:57.000+02:00
[Option Appraisal Module] [Package 1: Measures] Split 0: Move old measures to _legacy module
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ Code freeze date: YYYY-MM-DD
 
 ### Changed
 - Updated Impact Calculation Tutorial (`doc.climada_engine_Impact.ipynb`) [#1095](https://github.com/CLIMADA-project/climada_python/pull/1095).
+- Makes current `measure` module a legacy module, moving it to `_legacy_measure`, to retain compatibility with `CostBenefit` class and various tests. [#1274](https://github.com/CLIMADA-project/climada_python/pull/1274)
 
 ### Fixed
 
diff --git a/climada/engine/test/test_cost_benefit.py b/climada/engine/test/test_cost_benefit.py
@@ -33,10 +33,10 @@
     risk_rp_100,
     risk_rp_250,
 )
+from climada.entity._legacy_measures import Measure
+from climada.entity._legacy_measures.base import LOGGER as ILOG
 from climada.entity.disc_rates import DiscRates
 from climada.entity.entity_def import Entity
-from climada.entity.measures import Measure
-from climada.entity.measures.base import LOGGER as ILOG
 from climada.hazard.base import Hazard
 from climada.test import get_test_file
 from climada.util.api_client import Client
diff --git a/climada/engine/unsequa/input_var.py b/climada/engine/unsequa/input_var.py
@@ -518,7 +518,7 @@ def ent(
         exp_list : [climada.entity.exposures.base.Exposure]
             The list of base exposure. Can be one or many to uniformly sample
             from.
-        meas_set : climada.entity.measures.measure_set.MeasureSet
+        meas_set : climada.entity._legacy_measures.measure_set.MeasureSet
             The base measures.
         haz_id_dict : dict
             Dictionary of the impact functions affected by uncertainty.
@@ -660,7 +660,7 @@ def entfut(
         exp_list : [climada.entity.exposures.base.Exposure]
             The list of base exposure. Can be one or many to uniformly sample
             from.
-        meas_set : climada.entity.measures.measure_set.MeasureSet
+        meas_set : climada.entity._legacy_measures.measure_set.MeasureSet
             The base measures.
         haz_id_dict : dict
             Dictionary of the impact functions affected by uncertainty.
diff --git a/climada/entity/__init__.py b/climada/entity/__init__.py
@@ -19,8 +19,8 @@
 init entity
 """
 
+from ._legacy_measures import *
 from .disc_rates import *
 from .entity_def import *
 from .exposures import *
 from .impact_funcs import *
-from .measures import *
diff --git a/climada/entity/_legacy_measures/__init__.py b/climada/entity/_legacy_measures/__init__.py
diff --git a/climada/entity/_legacy_measures/base.py b/climada/entity/_legacy_measures/base.py
diff --git a/climada/entity/_legacy_measures/measure_set.py b/climada/entity/_legacy_measures/measure_set.py
@@ -32,7 +32,8 @@
 from matplotlib import colormaps as cm
 
 import climada.util.hdf5_handler as u_hdf5
-from climada.entity.measures.base import Measure
+
+from .base import Measure
 
 LOGGER = logging.getLogger(__name__)
 
diff --git a/climada/entity/_legacy_measures/test/__init__.py b/climada/entity/_legacy_measures/test/__init__.py
diff --git a/climada/entity/_legacy_measures/test/data/.gitignore b/climada/entity/_legacy_measures/test/data/.gitignore
diff --git a/climada/entity/_legacy_measures/test/test_base.py b/climada/entity/_legacy_measures/test/test_base.py
@@ -28,12 +28,12 @@
 import climada.entity.exposures.test as exposures_test
 import climada.util.coordinates as u_coord
 from climada import CONFIG
+from climada.entity._legacy_measures.base import IMPF_ID_FACT, Measure
+from climada.entity._legacy_measures.measure_set import MeasureSet
 from climada.entity.entity_def import Entity
 from climada.entity.exposures.base import Exposures
 from climada.entity.impact_funcs.base import ImpactFunc
 from climada.entity.impact_funcs.impact_func_set import ImpactFuncSet
-from climada.entity.measures.base import IMPF_ID_FACT, Measure
-from climada.entity.measures.measure_set import MeasureSet
 from climada.hazard.base import Hazard
 from climada.test import get_test_file
 from climada.util.constants import HAZ_DEMO_H5
diff --git a/climada/entity/_legacy_measures/test/test_meas_set.py b/climada/entity/_legacy_measures/test/test_meas_set.py
@@ -24,8 +24,8 @@
 import numpy as np
 
 from climada import CONFIG
-from climada.entity.measures.base import Measure
-from climada.entity.measures.measure_set import MeasureSet
+from climada.entity._legacy_measures.base import Measure
+from climada.entity._legacy_measures.measure_set import MeasureSet
 from climada.util.constants import ENT_DEMO_TODAY, ENT_TEMPLATE_XLS
 
 DATA_DIR = CONFIG.measures.test_data.dir()
@@ -58,7 +58,7 @@ def test_add_wrong_error(self):
         """Test error is raised when wrong ImpactFunc provided."""
         meas = MeasureSet()
         with self.assertLogs(
-            "climada.entity.measures.measure_set", level="WARNING"
+            "climada.entity._legacy_measures.measure_set", level="WARNING"
         ) as cm:
             meas.append(Measure())
         self.assertIn("Input Measure's hazard type not set.", cm.output[0])
@@ -76,7 +76,9 @@ def test_remove_measure_pass(self):
     def test_remove_wrong_error(self):
         """Test error is raised when invalid inputs."""
         meas = MeasureSet(measure_list=[Measure(name="Mangrove", haz_type="FL")])
-        with self.assertLogs("climada.entity.measures.measure_set", level="INFO") as cm:
+        with self.assertLogs(
+            "climada.entity._legacy_measures.measure_set", level="INFO"
+        ) as cm:
             meas.remove_measure(name="Seawall")
         self.assertIn("No Measure with name Seawall.", cm.output[0])
 
diff --git a/climada/entity/entity_def.py b/climada/entity/entity_def.py
@@ -26,10 +26,10 @@
 
 import pandas as pd
 
+from climada.entity._legacy_measures.measure_set import Measure, MeasureSet
 from climada.entity.disc_rates.base import DiscRates
 from climada.entity.exposures.base import Exposures
 from climada.entity.impact_funcs.impact_func_set import ImpactFuncSet
-from climada.entity.measures.measure_set import MeasureSet
 
 LOGGER = logging.getLogger(__name__)
 
diff --git a/climada/entity/test/test_entity.py b/climada/entity/test/test_entity.py
@@ -24,11 +24,11 @@
 import numpy as np
 
 from climada import CONFIG
+from climada.entity._legacy_measures.measure_set import MeasureSet
 from climada.entity.disc_rates.base import DiscRates
 from climada.entity.entity_def import Entity
 from climada.entity.exposures.base import Exposures
 from climada.entity.impact_funcs.impact_func_set import ImpactFuncSet
-from climada.entity.measures.measure_set import MeasureSet
 from climada.util.constants import ENT_TEMPLATE_XLS
 
 ENT_TEST_MAT = CONFIG.exposures.test_data.dir().joinpath("demo_today.mat")
diff --git a/climada/trajectories/calc_risk_metrics.py b/climada/trajectories/calc_risk_metrics.py
@@ -32,7 +32,7 @@
 import pandas as pd
 
 from climada.engine.impact import Impact
-from climada.entity.measures.base import Measure
+from climada.entity._legacy_measures.base import Measure
 from climada.trajectories.constants import (
     AAI_METRIC_NAME,
     COORD_ID_COL_NAME,
diff --git a/climada/trajectories/snapshot.py b/climada/trajectories/snapshot.py
@@ -31,9 +31,9 @@
 import numpy as np
 import pandas as pd
 
+from climada.entity._legacy_measures.base import Measure
 from climada.entity.exposures import Exposures
 from climada.entity.impact_funcs import ImpactFuncSet
-from climada.entity.measures.base import Measure
 from climada.hazard import Hazard
 
 LOGGER = logging.getLogger(__name__)
diff --git a/climada/trajectories/test/test_calc_risk_metrics.py b/climada/trajectories/test/test_calc_risk_metrics.py
@@ -26,10 +26,10 @@
 import pandas as pd
 import pytest
 
+from climada.entity._legacy_measures.base import Measure
 from climada.entity.exposures import Exposures
 from climada.entity.impact_funcs import ImpactFuncSet
 from climada.entity.impact_funcs.trop_cyclone import ImpfTropCyclone
-from climada.entity.measures.base import Measure
 from climada.hazard import Hazard
 from climada.trajectories.calc_risk_metrics import CalcRiskMetricsPoints
 from climada.trajectories.constants import (
diff --git a/climada/trajectories/test/test_snapshot.py b/climada/trajectories/test/test_snapshot.py
@@ -5,9 +5,9 @@
 import pandas as pd
 import pytest
 
+from climada.entity._legacy_measures.base import Measure
 from climada.entity.exposures import Exposures
 from climada.entity.impact_funcs import ImpactFunc, ImpactFuncSet
-from climada.entity.measures.base import Measure
 from climada.hazard import Hazard
 from climada.trajectories.snapshot import Snapshot
 from climada.util.constants import EXP_DEMO_H5, HAZ_DEMO_H5
diff --git a/doc/api/climada/climada.entity._legacy_measures.rst b/doc/api/climada/climada.entity._legacy_measures.rst
@@ -0,0 +1,22 @@
+climada\.entity\._legacy_measures package
+=========================================
+
+.. note::
+   This package implements the legacy way of defining measures
+   and is retained for compatibility.
+
+climada\.entity\._legacy_measures\.base module
+----------------------------------------------
+
+.. automodule:: climada.entity._legacy_measures.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+climada\.entity\._legacy_measures\.measure\_set module
+------------------------------------------------------
+
+.. automodule:: climada.entity._legacy_measures.measure_set
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/api/climada/climada.entity.measures.rst b/doc/api/climada/climada.entity.measures.rst
diff --git a/doc/api/climada/climada.entity.rst b/doc/api/climada/climada.entity.rst
@@ -6,7 +6,7 @@ climada\.entity package
     climada.entity.disc_rates
     climada.entity.exposures
     climada.entity.impact_funcs
-    climada.entity.measures
+    climada.entity._legacy_measures
 
 climada\.entity\.entity\_def module
 -----------------------------------
diff --git a/doc/user-guide/adaptation.rst b/doc/user-guide/adaptation.rst
@@ -0,0 +1,16 @@
+.. _adaptation-guides:
+
+==========================
+Adapation appraisal guides
+==========================
+
+These guides show everything you need to know in order to evaluate adaptation options with CLIMADA.
+
+.. toctree::
+    :maxdepth: 1
+
+    .. Adaptation measures in CLIMADA <climada_measures.ipynb>
+    .. Using measure configurations <climada_measure_config.ipynb>
+    .. Defining measure cash flows <climada_cost_income.ipynb>
+    .. Cost benefit evaluation <climada_cost_benefit.ipynb>
+    .. Adapation planning evaluation <climada_planning_evaluation.ipynb>
diff --git a/doc/user-guide/climada_engine_CostBenefit.ipynb b/doc/user-guide/climada_engine_CostBenefit.ipynb
diff --git a/doc/user-guide/climada_entity_MeasureSet.ipynb b/doc/user-guide/climada_entity_MeasureSet.ipynb
diff --git a/doc/user-guide/index.rst b/doc/user-guide/index.rst
