flood-adapt 1.1.4__py3-none-any.whl → 1.1.5__py3-none-any.whl

flood_adapt/__init__.py

@@ -1,5 +1,5 @@
 # has to be here at the start to avoid circular imports
-__version__ = "1.1.4"
+__version__ = "1.1.5"
 
 from flood_adapt import adapter, database_builder, dbs_classes, objects
 from flood_adapt.config.config import Settings

flood_adapt/database_builder/database_builder.py

@@ -1527,9 +1527,13 @@ class DatabaseBuilder:
             )
             # Add tide gauge as obs point if within model region
             if coord.within(model_region):
+                if self.tide_gauge.name is None:
+                    name = "tide_gauge"
+                else:
+                    name = self.tide_gauge.name
                 obs_points.append(
                     ObsPointModel(
-                        name=self.tide_gauge.name,
+                        name=name,
                         description="Tide gauge observation point",
                         ID=self.tide_gauge.ID,
                         lon=self.tide_gauge.lon,
@@ -1663,7 +1667,7 @@ class DatabaseBuilder:
             db_file_path.parent.mkdir(parents=True, exist_ok=True)
             shutil.copyfile(self.config.tide_gauge.file, db_file_path)
 
-            rel_db_path = Path(db_file_path.relative_to(self.static_path))
+            rel_db_path = Path(db_file_path.relative_to(self.static_path)).as_posix()
             logger.warning(
                 f"Tide gauge from file {rel_db_path} assumed to be in {self.unit_system.default_length_units}!"
             )
@@ -1795,26 +1799,22 @@ class DatabaseBuilder:
         if self.sfincs_offshore_model is None:
             return None
         # Connect boundary points of overland to output points of offshore
+        # First read in the boundary locations from the overland model
         fn = Path(self.sfincs_overland_model.root) / "sfincs.bnd"
-        bnd = pd.read_csv(fn, sep=" ", lineterminator="\n", header=None)
-        bnd = bnd.rename(columns={0: "x", 1: "y"})
-        bnd_geo = gpd.GeoDataFrame(
-            bnd,
-            geometry=gpd.points_from_xy(bnd.x, bnd.y),
+        lines = []
+        if fn.exists():
+            with open(fn) as f:
+                lines = f.readlines()
+        coords = [(float(line.split()[0]), float(line.split()[1])) for line in lines]
+        x, y = zip(*coords)
+        bnd = gpd.GeoDataFrame(
+            geometry=gpd.points_from_xy(x, y),
             crs=self.sfincs_overland_model.config["epsg"],
         )
-        obs_geo = bnd_geo.to_crs(4326)
-        obs_geo["x"] = obs_geo.geometry.x
-        obs_geo["y"] = obs_geo.geometry.y
-        del obs_geo["geometry"]
-        obs_geo["name"] = [f"bnd_pt{num:02d}" for num in range(1, len(obs_geo) + 1)]
-        fn_off = Path(self.sfincs_offshore_model.root) / "sfincs.obs"
-        obs_geo.to_csv(
-            fn_off,
-            sep="\t",
-            index=False,
-            header=False,
-        )
+        # Then transform points to offshore crs and save them as observation points
+        obs_geo = bnd.to_crs(self.sfincs_offshore_model.config["epsg"])
+        self.sfincs_offshore_model.setup_observation_points(obs_geo)
+        self.sfincs_offshore_model.write()
         logger.info(
             "Output points of the offshore SFINCS model were reconfigured to the boundary points of the overland SFINCS model."
         )

flood_adapt/dbs_classes/dbs_scenario.py

@@ -79,7 +79,8 @@ class DbsScenario(DbsTemplate[Scenario]):
         """
         event_left = self._database.events.get(left.event)
         event_right = self._database.events.get(right.event)
-        equal_events = event_left == event_right
+        # Deep-compare events including forcing data contents
+        equal_events = event_left.data_equivalent(event_right)
 
         left_projection = self._database.projections.get(left.projection)
         right_projection = self._database.projections.get(right.projection)

flood_adapt/objects/events/events.py

@@ -117,6 +117,63 @@ class Event(Object):
         for forcing in self.get_forcings():
             forcing.save_additional(output_dir)
 
+    def data_equivalent(self, other: "Event") -> bool:
+        """Deep-compare two events, including forcing data contents.
+
+        Compares core attributes (time, template, mode, rainfall_multiplier) and then
+        verifies that each forcing (by type) has the same data fingerprint. For
+        path-based forcings, the fingerprint hashes the file bytes; for others,
+        a canonical attribute-based hash is used.
+
+        Parameters
+        ----------
+        other : Event
+            The event to compare against.
+
+        Returns
+        -------
+        bool
+            True when events are equivalent in terms of their hazard inputs.
+        """
+        if not isinstance(other, Event):
+            return False
+
+        # Compare high-level attributes first
+        if (
+            self.template != other.template
+            or self.mode != other.mode
+            or self.rainfall_multiplier != other.rainfall_multiplier
+            or self.time != other.time
+        ):
+            return False
+
+        # Compare allowed forcing types present in each event
+        if set(self.forcings.keys()) != set(other.forcings.keys()):
+            return False
+
+        # Build comparable, sorted fingerprint lists per forcing type
+        def fingerprints(evt: "Event") -> dict[ForcingType, list[tuple[str, str]]]:
+            d: dict[ForcingType, list[tuple[str, str]]] = {}
+            for ftype, flist in evt.forcings.items():
+                fps: list[tuple[str, str]] = []
+                for f in flist:
+                    # Include source and the fingerprint to guard against collisions across different sources
+                    src = f.source.value if hasattr(f, "source") else ""
+                    fp = f.content_fingerprint()  # type: ignore[attr-defined]
+                    fps.append((src, fp))
+                # Sort for order-insensitive comparison
+                d[ftype] = sorted(fps, key=lambda t: (t[0], t[1]))
+            return d
+
+        left_fp = fingerprints(self)
+        right_fp = fingerprints(other)
+
+        for ftype in left_fp.keys():
+            if left_fp[ftype] != right_fp[ftype]:
+                return False
+
+        return True
+
     @classmethod
     def load_file(cls, file_path: Path | str | os.PathLike) -> "Event":
         """Load object from file.

flood_adapt/objects/forcing/forcing.py

@@ -1,3 +1,5 @@
+import hashlib
+import json
 import os
 from abc import ABC, abstractmethod
 from enum import Enum
@@ -72,7 +74,7 @@ class IForcing(BaseModel, ABC):
 
     def save_additional(self, output_dir: Path | str | os.PathLike) -> None:
         """Save additional data of the forcing."""
-        return
+        pass
 
     @field_serializer("path", check_fields=False)
     @classmethod
@@ -80,6 +82,49 @@ class IForcing(BaseModel, ABC):
         """Serialize filepath-like fields by saving only the filename. It is assumed that the file will be saved in the same directory."""
         return value.name
 
+    def content_fingerprint(self) -> str:
+        """Return a stable fingerprint of the forcing's underlying data.
+
+        - If a file-backed `path` attribute exists and the file exists, hash its bytes (SHA-256).
+        - Otherwise, hash a canonical JSON dump of the model (excluding volatile fields like `path`).
+
+        Returns
+        -------
+        str
+            A fingerprint string that changes when the forcing's effective data changes.
+        """
+        # Prefer hashing the actual file content when available
+        try:
+            p = getattr(self, "path", None)
+            if isinstance(p, Path) and p and p.exists():
+                sha = hashlib.sha256()
+                with p.open("rb") as f:
+                    for chunk in iter(lambda: f.read(8192), b""):
+                        sha.update(chunk)
+                # Include filename to disambiguate multi-forcing scenarios with identical content
+                return f"FILE:{p.name}:{sha.hexdigest()}"
+        except Exception:
+            # Fall through to attribute-based hashing if anything goes wrong
+            pass
+
+        # Fallback: hash the model attributes (excluding volatile fields like path)
+        data = self.model_dump(exclude_none=True)
+        # Remove potentially non-stable/absolute fields
+        data.pop("path", None)
+
+        # Ensure enums are serialized to their values for stable hashing
+        if isinstance(data.get("type"), Enum):
+            data["type"] = data["type"].value
+        if isinstance(data.get("source"), Enum):
+            data["source"] = data["source"].value
+
+        payload = json.dumps(data, sort_keys=True, default=str).encode("utf-8")
+        return f"ATTR:{hashlib.sha256(payload).hexdigest()}"
+
+    def _post_load(self, file_path: Path | str | os.PathLike, **kwargs) -> None:
+        """Post-load hook, called at the end of `load_file`, to perform any additional loading steps after loading from file."""
+        return
+
 
 class IDischarge(IForcing):
     type: ForcingType = ForcingType.DISCHARGE

flood_adapt/objects/forcing/tide_gauge.py

@@ -8,6 +8,7 @@ import requests
 from noaa_coops.station import COOPSAPIError
 from pydantic import BaseModel, model_validator
 
+from flood_adapt.config import Settings
 from flood_adapt.misc.log import FloodAdaptLogging
 from flood_adapt.objects.forcing import unit_system as us
 from flood_adapt.objects.forcing.time_frame import TimeFrame
@@ -56,7 +57,7 @@ class TideGauge(BaseModel):
     source: TideGaugeSource
     reference: str
     ID: Optional[int] = None  # Attribute used to download from correct gauge
-    file: Optional[Path] = None  # for locally stored data
+    file: Optional[str] = None  # for locally stored data
     lat: Optional[float] = None
     lon: Optional[float] = None
     units: us.UnitTypesLength = (
@@ -104,7 +105,8 @@ class TideGauge(BaseModel):
         """
         logger.info(f"Retrieving waterlevels for tide gauge {self.ID} for {time}")
         if self.file:
-            gauge_data = self._read_imported_waterlevels(time=time, path=self.file)
+            abs_path = Settings().database_path / "static" / self.file
+            gauge_data = self._read_imported_waterlevels(time=time, path=abs_path)
         else:
             gauge_data = self._download_tide_gauge_data(time=time)
 

{flood_adapt-1.1.4.dist-info → flood_adapt-1.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 1.1.4
+Version: 1.1.5
 Summary: A software package support system which can be used to assess the benefits and costs of flood resilience measures
 Author-email: Gundula Winter <Gundula.Winter@deltares.nl>, Panos Athanasiou <Panos.Athanasiou@deltares.nl>, Frederique de Groen <Frederique.deGroen@deltares.nl>, Tim de Wilde <Tim.deWilde@deltares.nl>, Julian Hofer <Julian.Hofer@deltares.nl>, Daley Adrichem <Daley.Adrichem@deltares.nl>, Luuk Blom <Luuk.Blom@deltares.nl>
 License: ====================================================

{flood_adapt-1.1.4.dist-info → flood_adapt-1.1.5.dist-info}/RECORD

@@ -1,4 +1,4 @@
-flood_adapt/__init__.py,sha256=HuJSWvtJutuwuiXwgvArRmpnG72guATUP3IFvzowaJY,779
+flood_adapt/__init__.py,sha256=qZBLP5qxMYURIbpEB6pRkz3wIeIVQZ0N9wTSJgxs_BA,779
 flood_adapt/flood_adapt.py,sha256=HVFS4OFhcB0TqHtMw3kbEei0IfJxsciauHfG3XZ38-0,40747
 flood_adapt/adapter/__init__.py,sha256=vnF8NCkEVX-N-gtGS-J_A1H1YYAjihWjJZFyYGwcp8Q,180
 flood_adapt/adapter/fiat_adapter.py,sha256=seDjPoumkhUOd7qer3ni1_Ut3dwyq0-_yhJNaTEFc2E,60284
@@ -18,7 +18,7 @@ flood_adapt/config/impacts.py,sha256=O7vE7jB3GSXnkqAvv7TqJiJ_j1uJ3mck_KQ-ScsB3bo
 flood_adapt/config/sfincs.py,sha256=y8C3PzFwwgMB_sb8rBzgteaQ8fCxep6DnZxuk0q__bc,4825
 flood_adapt/config/site.py,sha256=VR90jCHWcxgoQJptNyXy7LseGjXUDRtdOjNGCddFVzI,4328
 flood_adapt/database_builder/__init__.py,sha256=h4ietZ6sAZa7j2kvSzp5-58BueGrfJsXvq8PFu1RLyI,1112
-flood_adapt/database_builder/database_builder.py,sha256=cv_uwkKqgc8RLQ5lAmTqRN1fm5gBOYbIVR3v2MgD_gY,109935
+flood_adapt/database_builder/database_builder.py,sha256=nPwkBQpDzl74OrgF3hjQiDJprtxtdJuu0HsY3jNvJiM,110065
 flood_adapt/database_builder/metrics_utils.py,sha256=aU7YfXLmBjFT0fQQQl3o0yIzdFJ6XJGlld0GnkJytGc,66258
 flood_adapt/database_builder/templates/default_units/imperial.toml,sha256=zIjPlxIa2kWLUjSYisd8UolXGo5iKdFoDDz_JkKBXTM,295
 flood_adapt/database_builder/templates/default_units/metric.toml,sha256=tc0XMKs7xGL9noB9lAb0gyQfjYxzokgHa3NqpccxWl0,302
@@ -61,7 +61,7 @@ flood_adapt/dbs_classes/dbs_benefit.py,sha256=ayEYz8ga49HLdYuUsDWZOuZnpRnBpTuyhv
 flood_adapt/dbs_classes/dbs_event.py,sha256=ak3kHan6L1EfC8agDLKiCe8gaY5leOmj_qUBsI61q9A,1869
 flood_adapt/dbs_classes/dbs_measure.py,sha256=vVs-LtnHJN7eSGIFUglJdpbtfq_QI_Ftkv4lh5mfnNM,4085
 flood_adapt/dbs_classes/dbs_projection.py,sha256=lyiU_ctP2ixK28RKnBN6mVJbOuaDsWCj1y6-MHlyi_k,1078
-flood_adapt/dbs_classes/dbs_scenario.py,sha256=LHWx3Dr1XR47bPyPRkR70h3VcT0f0MVgB-R8V_G_O04,3993
+flood_adapt/dbs_classes/dbs_scenario.py,sha256=bD5VjuojgE_79ZN7bZNpnbpthI9uYUwMSsrPDDcjlvg,4070
 flood_adapt/dbs_classes/dbs_static.py,sha256=Yzs-bsfAq2jkZ_-0_ojuzNf81Wifaxw8a1APNNS0mqM,10565
 flood_adapt/dbs_classes/dbs_strategy.py,sha256=qiEObHZeYL93GmdjSiGQls1ZmxdMZPkRkwzHgmoYwyE,4856
 flood_adapt/dbs_classes/dbs_template.py,sha256=b2x2sWNYTnaWU8Plgp51PFPrZGEv2kRRn9JBAgYhLbI,11578
@@ -82,20 +82,20 @@ flood_adapt/objects/benefits/benefits.py,sha256=1Di8v2B7YOdMkRlg0A6k6qtMqYE_JaaN
 flood_adapt/objects/events/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flood_adapt/objects/events/event_factory.py,sha256=CYq8itWurILPGNSDtWKWV5FF4UxjrRFiza6w2OQJEdU,4276
 flood_adapt/objects/events/event_set.py,sha256=fpmNbrd3qXWPgyqphv_Rf2iNsZCLvwz6YEbjMV7WIXA,2810
-flood_adapt/objects/events/events.py,sha256=xuZsmew4oG2TTh7M3lRLr0z2k-T-XU2ahbi-l_uPNGY,8341
+flood_adapt/objects/events/events.py,sha256=Kqwyeh9MMp8ex6DBbg-rqBnp6RsrbR1J7bfO9ybevh4,10580
 flood_adapt/objects/events/historical.py,sha256=uIQ7icy9F3pOW0R-fBqjEjU857SGlJO81S104mzvtLY,2081
 flood_adapt/objects/events/hurricane.py,sha256=dOPMa5c4mz1umLne9ydkBqnLTig9D95LmPHSFE5wit8,2401
 flood_adapt/objects/events/synthetic.py,sha256=Q8OHbBumeEwbrzA1imBrxiGiB92RWyigVcGVUbisSh4,1366
 flood_adapt/objects/forcing/__init__.py,sha256=wzPrflMLiEolocs3UcLeg05u5ydMDhF00jEf9zsC76c,2141
 flood_adapt/objects/forcing/csv.py,sha256=AMHlE5K_QiMOqD2pRRbG4ojnZ9VPiQjtk2wMFSouKjk,2027
 flood_adapt/objects/forcing/discharge.py,sha256=GIuKETXizwuaeIbHlu0fELQwC0ttfZSDiUMRm4HEyWY,2057
-flood_adapt/objects/forcing/forcing.py,sha256=MonjhiHP6ge_5UFDMcLmj0pt5jK76Eznb4F7q3d8nAg,4356
+flood_adapt/objects/forcing/forcing.py,sha256=n2IEk21Ih0GkddH3IqoV8egAYh4UCAVEyz_O0kk2fvE,6386
 flood_adapt/objects/forcing/forcing_factory.py,sha256=lpugKlMt0MN8BxyykottMOuQd_fp1MHrkuuqbHWWdRY,5965
 flood_adapt/objects/forcing/meteo_handler.py,sha256=rTxY5WNobK_Ifzj2eVcoSPGgb3TzuZljSv_dLn5FLo8,3016
 flood_adapt/objects/forcing/netcdf.py,sha256=ZBzFtN5joVs36lVjvYErVaHEylUQ6eKIhR0uk_MD-zM,1388
 flood_adapt/objects/forcing/plotting.py,sha256=Y7f_9bY8d9jbd7BqEAeRmof-aaJhlznM3_wGBOI7g-s,14828
 flood_adapt/objects/forcing/rainfall.py,sha256=e6P3IMzItvnsmXbcMXl1oV-d9LDuh3jTIc_vt6Kz5zo,3282
-flood_adapt/objects/forcing/tide_gauge.py,sha256=XhplyNHtCn0hRM1oeD5v-fMYAOLAJIKidmxKxVxCUlw,7188
+flood_adapt/objects/forcing/tide_gauge.py,sha256=uPgvlcvDtZFQrtTyXX2d5YmSvCnjYYg0Xsu8NAwQZPQ,7299
 flood_adapt/objects/forcing/time_frame.py,sha256=1X3G0Ax18BHRvAomf-CW_ISRk_3qgAakwgZCIBxIkL4,2855
 flood_adapt/objects/forcing/timeseries.py,sha256=bD27JWzC3owq5ah3zPzJ7xoUzSH_t4J03s_SycYW0mQ,19740
 flood_adapt/objects/forcing/unit_system.py,sha256=7FFOmaxq6EOvXx64QDxlpNU4uMExqridFcdFwyTJ4Lo,16542
@@ -114,8 +114,8 @@ flood_adapt/objects/strategies/strategies.py,sha256=Jw-WJDCamL9p_7VEir3AdmYPMVAi
 flood_adapt/workflows/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flood_adapt/workflows/benefit_runner.py,sha256=eA21TuHdeZ6QYO8ehXri6BHlkyHsVsZphIdIca5g0KA,21824
 flood_adapt/workflows/scenario_runner.py,sha256=9_Y6GmMYhYoTRkBUIlju0eBy6DosGf4Zl2tgu1QEubI,4119
-flood_adapt-1.1.4.dist-info/LICENSE,sha256=Ui5E03pQ0EVKxvKA54lTPA1xrtgA2HMGLQai95eOzoE,36321
-flood_adapt-1.1.4.dist-info/METADATA,sha256=70kUiml9cQzOes7B0XAgpqzYCU1kAYuhSAiXLdmqa8U,48806
-flood_adapt-1.1.4.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-flood_adapt-1.1.4.dist-info/top_level.txt,sha256=JvzMi6cTcQPEThCfpgMEeVny3ghI1urSH0CCgVIqSzw,12
-flood_adapt-1.1.4.dist-info/RECORD,,
+flood_adapt-1.1.5.dist-info/LICENSE,sha256=Ui5E03pQ0EVKxvKA54lTPA1xrtgA2HMGLQai95eOzoE,36321
+flood_adapt-1.1.5.dist-info/METADATA,sha256=yGKj5wuwDfXXwLSnJVfZmywRC4hZAJ_g2NrYeuCvg5I,48806
+flood_adapt-1.1.5.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+flood_adapt-1.1.5.dist-info/top_level.txt,sha256=JvzMi6cTcQPEThCfpgMEeVny3ghI1urSH0CCgVIqSzw,12
+flood_adapt-1.1.5.dist-info/RECORD,,