flood-adapt 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

flood_adapt/__init__.py

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

flood_adapt/dbs_classes/database.py

@@ -2,9 +2,8 @@ import gc
 import os
 import shutil
 import time
-from datetime import datetime
 from pathlib import Path
-from typing import Any, Optional, Union
+from typing import Any, Literal, Optional, Union
 
 import geopandas as gpd
 import numpy as np
@@ -566,7 +565,12 @@ class Database(IDatabase):
             gdfs[label] = gdfs[label].to_crs(4326)
         return gdfs
 
-    def get_object_list(self, object_type: str) -> dict[str, Any]:
+    def get_object_list(
+        self,
+        object_type: Literal[
+            "projections", "events", "measures", "strategies", "scenarios", "benefits"
+        ],
+    ) -> dict[str, Any]:
         """Get a dictionary with all the toml paths and last modification dates that exist in the database that correspond to object_type.
 
         Parameters
@@ -579,20 +583,23 @@ class Database(IDatabase):
         dict[str, Any]
             Includes 'path' and 'last_modification_date' info
         """
-        paths = [
-            path / f"{path.name}.toml"
-            for path in list((self.input_path / object_type).iterdir())
-        ]
-        last_modification_date = [
-            datetime.fromtimestamp(file.stat().st_mtime) for file in paths
-        ]
-
-        objects = {
-            "path": paths,
-            "last_modification_date": last_modification_date,
-        }
-
-        return objects
+        match object_type:
+            case "projections":
+                return self.projections.list_objects()
+            case "events":
+                return self.events.list_objects()
+            case "measures":
+                return self.measures.list_objects()
+            case "strategies":
+                return self.strategies.list_objects()
+            case "scenarios":
+                return self.scenarios.list_objects()
+            case "benefits":
+                return self.benefits.list_objects()
+            case _:
+                raise ValueError(
+                    f"Object type '{object_type}' is not valid. Must be one of 'projections', 'events', 'measures', 'strategies' or 'scenarios'."
+                )
 
     def has_run_hazard(self, scenario_name: str) -> None:
         """Check if there is already a simulation that has the exact same hazard component.

flood_adapt/dbs_classes/dbs_event.py

@@ -1,5 +1,4 @@
 from pathlib import Path
-from typing import Any
 
 from flood_adapt.dbs_classes.dbs_template import DbsTemplate
 from flood_adapt.objects.events.event_factory import EventFactory
@@ -34,20 +33,6 @@ class DbsEvent(DbsTemplate[Event]):
         # Load event
         return EventFactory.load_file(event_path)
 
-    def list_objects(self) -> dict[str, list[Any]]:
-        """Return a dictionary with info on the events that currently exist in the database.
-
-        Returns
-        -------
-        dict[str, Any]
-            Includes 'name', 'description', 'path' and 'last_modification_date' info
-        """
-        events = self._get_object_list()
-        objects = [self.get(name) for name in events["name"]]
-        events["description"] = [obj.description for obj in objects]
-        events["objects"] = objects
-        return events
-
     def _check_standard_objects(self, name: str) -> bool:
         """Check if an event is a standard event.
 

flood_adapt/dbs_classes/dbs_measure.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from typing import Any
 
 import geopandas as gpd
@@ -26,9 +27,15 @@ class DbsMeasure(DbsTemplate[Measure]):
         Measure
             measure object
         """
-        measure_path = self.input_path / name / f"{name}.toml"
-        measure = MeasureFactory.get_measure_object(measure_path)
-        return measure
+        # Make the full path to the object
+        full_path = self.input_path / name / f"{name}.toml"
+
+        # Check if the object exists
+        if not Path(full_path).is_file():
+            raise ValueError(f"{self.display_name}: '{name}' does not exist.")
+
+        # Load and return the object
+        return MeasureFactory.get_measure_object(full_path)
 
     def list_objects(self) -> dict[str, list[Any]]:
         """Return a dictionary with info on the measures that currently exist in the database.
@@ -39,14 +46,15 @@ class DbsMeasure(DbsTemplate[Measure]):
             Includes 'name', 'description', 'path' and 'last_modification_date' info
         """
         measures = self._get_object_list()
-        objects = [MeasureFactory.get_measure_object(path) for path in measures["path"]]
+        objects = [self.get(name) for name in measures["name"]]
+
         measures["description"] = [obj.description for obj in objects]
         measures["objects"] = objects
 
         geometries = []
-        for path, obj in zip(measures["path"], objects):
+        for obj in objects:
             # If polygon is used read the polygon file
-            if obj.polygon_file:
+            if hasattr(obj, "polygon_file") and obj.polygon_file:
                 src_path = resolve_filepath(
                     object_dir=self.dir_name,
                     obj_name=obj.name,
@@ -54,7 +62,7 @@ class DbsMeasure(DbsTemplate[Measure]):
                 )
                 geometries.append(gpd.read_file(src_path))
             # If aggregation area is used read the polygon from the aggregation area name
-            elif obj.aggregation_area_name:
+            elif hasattr(obj, "aggregation_area_name") and obj.aggregation_area_name:
                 if (
                     obj.aggregation_area_type
                     not in self._database.static.get_aggregation_areas()

flood_adapt/dbs_classes/dbs_template.py

@@ -60,10 +60,9 @@ class DbsTemplate(AbstractDatabaseElement[T_OBJECTMODEL]):
         object_list = self._get_object_list()
 
         # Load all objects
-        objects = [self._object_class.load_file(path) for path in object_list["path"]]
+        objects = [self.get(name) for name in object_list["name"]]
 
-        # From the loaded objects, get the name and description and add them to the object_list
-        object_list["name"] = [obj.name for obj in objects]
+        # From the loaded objects, get the description and add them to the object_list
         object_list["description"] = [obj.description for obj in objects]
         object_list["objects"] = objects
         return object_list
@@ -248,7 +247,7 @@ class DbsTemplate(AbstractDatabaseElement[T_OBJECTMODEL]):
         Returns
         -------
         dict[str, Any]
-            A dictionary that contains the keys: `name` to 'path' and 'last_modification_date'
+            A dictionary that contains the keys: `name` to `path` and `last_modification_date`
             Each key has a list of the corresponding values, where the index of the values corresponds to the same object.
         """
         # If the toml doesnt exist, we might be in the middle of saving a new object or could be a broken object.

flood_adapt/objects/events/events.py

@@ -200,7 +200,7 @@ class Event(Object):
                     f"Allowed sources are: {allowed_sources}"
                 )
 
-        if Settings().validate_allowed_forcings:
+        if Settings().validate_allowed_forcings and hasattr(self, "ALLOWED_FORCINGS"):
             # Validate forcings
             for _, concrete_forcings in self.forcings.items():
                 for concrete_forcing in concrete_forcings:

flood_adapt/objects/forcing/timeseries.py

@@ -331,15 +331,21 @@ class BlockTimeseries(SyntheticTimeseries):
             end=(REFERENCE_TIME + self.end_time.to_timedelta()),
             freq=time_step,
         )
-        ts = np.zeros((len(tt),)) + self.peak_value.value
+        if self.peak_value:
+            height_value = self.peak_value.value
+        elif self.cumulative:
+            area = self.cumulative.value
+            base = self.duration.convert(
+                us.UnitTypesTime.hours
+            )  # always expect duration in hours
+            height_value = area / base
+
+        ts = np.zeros((len(tt),)) + height_value
         return ts
 
     @model_validator(mode="after")
     def validate_attrs(self):
-        if not self.peak_value:
-            raise ValueError(
-                f"{self.__class__.__name__} must have `peak_value` specified. {self.peak_value}"
-            )
+        # either peak_value or cumulative must be set, which is already checked in the parent class: `either_value_or_cumulative`
         return self
 
 
@@ -355,17 +361,26 @@ class TriangleTimeseries(SyntheticTimeseries):
             freq=time_step,
         )
         tt_seconds = (tt - REFERENCE_TIME).total_seconds()
+        peak_time = self.peak_time.to_timedelta().total_seconds()
+        start_time = self.start_time.to_timedelta().total_seconds()
+
+        if self.peak_value:
+            height_value = self.peak_value.value
+        elif self.cumulative:
+            area = self.cumulative.value
+            base = self.duration.convert(
+                us.UnitTypesTime.hours
+            )  # always expect duration in hours
+            height_value = (2 * area) / base
 
         ascending_slope = (
-            self.peak_value.value
+            height_value
             / (self.peak_time - self.start_time).to_timedelta().total_seconds()
         )
         descending_slope = (
-            -self.peak_value.value
+            -height_value
             / (self.end_time - self.peak_time).to_timedelta().total_seconds()
         )
-        peak_time = self.peak_time.to_timedelta().total_seconds()
-        start_time = self.start_time.to_timedelta().total_seconds()
 
         ts = np.piecewise(
             tt_seconds,
@@ -373,7 +388,7 @@ class TriangleTimeseries(SyntheticTimeseries):
             [
                 lambda x: np.maximum(ascending_slope * (x - start_time), 0),
                 lambda x: np.maximum(
-                    descending_slope * (x - peak_time) + self.peak_value.value, 0
+                    descending_slope * (x - peak_time) + height_value, 0
                 ),
                 0,
             ],
@@ -382,10 +397,7 @@ class TriangleTimeseries(SyntheticTimeseries):
 
     @model_validator(mode="after")
     def validate_attrs(self):
-        if not self.peak_value:
-            raise ValueError(
-                f"{self.__class__.__name__} must have `peak_value` specified. {self.peak_value}"
-            )
+        # either peak_value or cumulative must be set, which is already checked in the parent class: `either_value_or_cumulative`
         return self
 
 
@@ -549,4 +561,4 @@ class TimeseriesFactory:
 
     @staticmethod
     def from_object(obj: SyntheticTimeseries) -> SyntheticTimeseries:
-        return TimeseriesFactory.from_args(**obj.model_dump())
+        return TimeseriesFactory.from_args(**obj.model_dump(exclude_none=True))

{flood_adapt-0.3.0.dist-info → flood_adapt-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.0
+Version: 0.3.1
 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>
 Project-URL: Source, https://github.com/Deltares-research/FloodAdapt

{flood_adapt-0.3.0.dist-info → flood_adapt-0.3.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-flood_adapt/__init__.py,sha256=qr2n76U7FJKoIQRAha8u1esAPHPpP3yEWXkbE1GWAKI,596
+flood_adapt/__init__.py,sha256=YmSOHgogAZ9iXZ-KEQR6w8Yk-H-T8_aY8UZ2jcjCIl0,596
 flood_adapt/database_builder.py,sha256=eq_LAqaGpV-KJkLNBVvXjyjFRDQaBFA5ubANiuVsZWU,420
 flood_adapt/flood_adapt.py,sha256=9_JJtB96QWF9GEYTzs4WEAScYPYwt8Ye3VnCD5UHMAU,39229
 flood_adapt/adapter/__init__.py,sha256=C6XBZK8x4MHe3beeKa9rPbXn0-gBHPEPnTKn14C-5gI,249
@@ -75,15 +75,15 @@ flood_adapt/database_builder/templates/infometrics/US_NSI/without_SVI/infographi
 flood_adapt/database_builder/templates/infometrics/US_NSI/without_SVI/infographic_metrics_config_risk.toml,sha256=ayNiJHEMdRk82nhfV1srRNavUtxpQEWX71fJf9nsxu4,1988
 flood_adapt/database_builder/templates/mapbox_layers/bin_colors.toml,sha256=OXlAdFfu3S99qrxFqn_Xu6ZIZMvk-0_LQhdsj5q_rZk,412
 flood_adapt/dbs_classes/__init__.py,sha256=_8DX6dK62U1RjRKz0zOgM0yR-kiBlBxz2dLkCWylmXc,710
-flood_adapt/dbs_classes/database.py,sha256=RBwC_fEFAp48fxiyNay6am1rGGb55LL48UBWrT3YWlw,25332
+flood_adapt/dbs_classes/database.py,sha256=FVpwnx4gEWnY6IEALsfWgZNk3DrZXW5blEzRPdm__ew,25772
 flood_adapt/dbs_classes/dbs_benefit.py,sha256=Fzm0eCWOPFLorKkk86Qzt4Wq0ZGJTh1vwJ5I6vm-6zQ,3096
-flood_adapt/dbs_classes/dbs_event.py,sha256=5khfCMn05TPe4mA1o6ApAvtIPMmlLrT_uLe_40M-r_k,2702
-flood_adapt/dbs_classes/dbs_measure.py,sha256=oOOkSPuaq2seG3l2c2nZ_eMi9SrH-c7EZnC2ijTXI1Q,3613
+flood_adapt/dbs_classes/dbs_event.py,sha256=EfupVyP5XwiNM9dTuJBKCqQBruAO_Ma_IgoxlFlG-L8,2150
+flood_adapt/dbs_classes/dbs_measure.py,sha256=EwIBphrR48jIoyRvRYq8dF8tBchq3xftD4kzgFQxbD4,3868
 flood_adapt/dbs_classes/dbs_projection.py,sha256=wVtcP8grBbQ-Y2_Rvjp9Rw8ae2uZoLeGRutiuf0aJrg,1575
 flood_adapt/dbs_classes/dbs_scenario.py,sha256=P7yyLSYt-W1TgNbsNyF9XvB6UNv-9qVR5DXfq6G4UaQ,5138
 flood_adapt/dbs_classes/dbs_static.py,sha256=LKBDrqoRcLUZmkT4683kB61kbgHp5atVE5qq6U9dpig,9099
 flood_adapt/dbs_classes/dbs_strategy.py,sha256=kgqbnUyG9_IMS1oIsqgZkiMgrDuhV_Hw0pfFQcJDMjc,5284
-flood_adapt/dbs_classes/dbs_template.py,sha256=mii9PpngbEtFUO4Y0Xj_AtFcXn_HO2H7kW1eGmf0AbI,11118
+flood_adapt/dbs_classes/dbs_template.py,sha256=cSSoXu8_kvReOLQxTeIoBms3cz9lqG6OxcmcZ93hrVw,11029
 flood_adapt/dbs_classes/interface/database.py,sha256=HcJWAQP3mx5rKWvdHeqG8id-AqzYgOXGIrIAR7WhkmA,3510
 flood_adapt/dbs_classes/interface/element.py,sha256=gKFtE-a0cnkMpXrAwrYFWSvzhePSbDqFxwz6ChS0O6E,3772
 flood_adapt/dbs_classes/interface/static.py,sha256=3kLaWabSWKe7h8-SiBTJlr09sO8Ykbk4NIE5mrMoCp0,1225
@@ -99,7 +99,7 @@ flood_adapt/objects/benefits/benefits.py,sha256=Jk-PsHM3sxp6pUoT28tMuxF-IsONVNH5
 flood_adapt/objects/events/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flood_adapt/objects/events/event_factory.py,sha256=sGBNyFijKXT-Ltx7vEyiJpnSnBOoSLnYyuI6NC7ZtuM,4068
 flood_adapt/objects/events/event_set.py,sha256=NqaP1TA4pXWtjDG0bfIflT2E6aPPqULClenWLqNsG4A,2584
-flood_adapt/objects/events/events.py,sha256=g1PrdBJostlVN6DFiJoyCf8LJ8pjcCNwOnvnK78z8PM,8118
+flood_adapt/objects/events/events.py,sha256=GKVRDNCLtGUhABIdpzk1v_J0g2fB2OFNSCO6-ERTuBM,8156
 flood_adapt/objects/events/historical.py,sha256=AvafuI8Pc8SWie7e7p0yxLM7IXJ7WJnpSF90iJacJGI,1679
 flood_adapt/objects/events/hurricane.py,sha256=QwnXQ2jXAqDHP82ANVAJZlZQ2umoJLA401Bx6X6KT4I,2093
 flood_adapt/objects/events/synthetic.py,sha256=kJy2DN9JqXsBqhW7nzgBwTltscHTnoKpbE0jH7u4BmA,1380
@@ -114,7 +114,7 @@ flood_adapt/objects/forcing/plotting.py,sha256=dfhSY6_IfJzG1N0ivGTWjCMtiBj-4UAyG
 flood_adapt/objects/forcing/rainfall.py,sha256=ndR1T-Zi-m7eek-7w1VGJC3xPlDq97yGvgqKctz647c,3184
 flood_adapt/objects/forcing/tide_gauge.py,sha256=T6XLOAuFvUjThbg0PcSbMs1_m-SpZ9W2pQ-4q48HdNk,6996
 flood_adapt/objects/forcing/time_frame.py,sha256=u1slwo2aJHG3lK7QWNMY1yL84adpW7yfrlMlZO1sgbs,2415
-flood_adapt/objects/forcing/timeseries.py,sha256=NR0jR9j5HQEtUZlCc0eFhsREVZArl9Mg2TSD9RrQR5Q,18641
+flood_adapt/objects/forcing/timeseries.py,sha256=uSWIRP7KNsH_iy0DcE2S1gaP0mFtft2pEPA74redUGE,19178
 flood_adapt/objects/forcing/unit_system.py,sha256=oYk09TC0ksyeqHmT2CkA2fPkKYFR2YeT-ymvnXAAbJM,15922
 flood_adapt/objects/forcing/waterlevels.py,sha256=oKVKXA0SMbOPujCFn53agpJpqXuC7cawF8wfHbxUSgA,3329
 flood_adapt/objects/forcing/wind.py,sha256=VtbopiBGyi2T6Id0fnRKYLTzfRt9f_QxupyxIyFZQKI,3801
@@ -132,8 +132,8 @@ flood_adapt/workflows/benefit_runner.py,sha256=nLmWqbzBsXJOikCnm7S6tSbJ9Ex1zjkVL
 flood_adapt/workflows/floodmap.py,sha256=6XatakhiZDkIi82VpRDb5dWtWAs-aSho8_iaCGph1_c,2932
 flood_adapt/workflows/impacts_integrator.py,sha256=Iq8namwu90SP_BTazUsDqROqOrJk7rGEyR6nA1Q7Vho,2330
 flood_adapt/workflows/scenario_runner.py,sha256=6d1ypkHNdFgL7WMEXiM3scBs43IfLFqueGqL4LI9emQ,2833
-flood_adapt-0.3.0.dist-info/LICENSE,sha256=K5036N4YhOu7BzQ4o2tQbe1NBYOqI-WF3ahlmdm5PlU,1065
-flood_adapt-0.3.0.dist-info/METADATA,sha256=dGVGJfUuA-I3wTikKwVeyFJfsQcvM8q6UJ7Sriv173I,10801
-flood_adapt-0.3.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-flood_adapt-0.3.0.dist-info/top_level.txt,sha256=JvzMi6cTcQPEThCfpgMEeVny3ghI1urSH0CCgVIqSzw,12
-flood_adapt-0.3.0.dist-info/RECORD,,
+flood_adapt-0.3.1.dist-info/LICENSE,sha256=K5036N4YhOu7BzQ4o2tQbe1NBYOqI-WF3ahlmdm5PlU,1065
+flood_adapt-0.3.1.dist-info/METADATA,sha256=PZENK0K3uWXuKMLj3Fzi-a6aniKcM9utSXy3hHixA4s,10801
+flood_adapt-0.3.1.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+flood_adapt-0.3.1.dist-info/top_level.txt,sha256=JvzMi6cTcQPEThCfpgMEeVny3ghI1urSH0CCgVIqSzw,12
+flood_adapt-0.3.1.dist-info/RECORD,,