flood-adapt 0.3.6__tar.gz → 0.3.8__tar.gz

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.6
+Version: 0.3.8
 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:                     GNU GENERAL PUBLIC LICENSE

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/__init__.py

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

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/adapter/sfincs_adapter.py

@@ -12,7 +12,6 @@ import hydromt_sfincs.utils as utils
 import numpy as np
 import pandas as pd
 import plotly.express as px
-import plotly.graph_objects as go
 import pyproj
 import shapely
 import xarray as xr
@@ -677,7 +676,8 @@ class SfincsAdapter(IHazardAdapter):
             )
 
             event = self.database.events.get(scenario.event)
-            self._add_tide_gauge_plot(fig, event, units=gui_units)
+            if self.settings.obs_point[ii].name == self.settings.tide_gauge.name:
+                self._add_tide_gauge_plot(fig, event, units=gui_units)
 
             # write html to results folder
             station_name = gdf.iloc[ii]["Name"]
@@ -686,26 +686,27 @@ class SfincsAdapter(IHazardAdapter):
 
     def add_obs_points(self):
         """Add observation points provided in the site toml to SFINCS model."""
-        if self.settings.obs_point is not None:
-            self.logger.info("Adding observation points to the overland flood model")
-
-            obs_points = self.settings.obs_point
-            names = []
-            lat = []
-            lon = []
-            for pt in obs_points:
-                names.append(pt.name)
-                lat.append(pt.lat)
-                lon.append(pt.lon)
+        if self.settings.obs_point is None:
+            return
+        self.logger.info("Adding observation points to the overland flood model")
 
-            # create GeoDataFrame from obs_points in site file
-            df = pd.DataFrame({"name": names})
-            gdf = gpd.GeoDataFrame(
-                df, geometry=gpd.points_from_xy(lon, lat), crs="EPSG:4326"
-            )
+        obs_points = self.settings.obs_point
+        names = []
+        lat = []
+        lon = []
+        for pt in obs_points:
+            names.append(pt.name)
+            lat.append(pt.lat)
+            lon.append(pt.lon)
+
+        # create GeoDataFrame from obs_points in site file
+        df = pd.DataFrame({"name": names})
+        gdf = gpd.GeoDataFrame(
+            df, geometry=gpd.points_from_xy(lon, lat), crs="EPSG:4326"
+        )
 
-            # Add locations to SFINCS file
-            self._model.setup_observation_points(locations=gdf, merge=False)
+        # Add locations to SFINCS file
+        self._model.setup_observation_points(locations=gdf, merge=False)
 
     def get_wl_df_from_offshore_his_results(self) -> pd.DataFrame:
         """Create a pd.Dataframe with waterlevels from the offshore model at the bnd locations of the overland model.
@@ -1309,15 +1310,11 @@ class SfincsAdapter(IHazardAdapter):
         # Make sure no multipolygons are there
         gdf_green_infra = gdf_green_infra.explode()
 
-        # Volume is always already calculated and is converted to m3 for SFINCS
-        height = None
-        volume = green_infrastructure.volume.convert(
-            us.UnitTypesVolume(us.UnitTypesVolume.m3)
-        )
-
         # HydroMT function: create storage volume
         self._model.setup_storage_volume(
-            storage_locs=gdf_green_infra, volume=volume, height=height, merge=True
+            storage_locs=gdf_green_infra,
+            volume=green_infrastructure.volume.convert(us.UnitTypesVolume.m3),
+            merge=True,
         )
 
     def _add_measure_pump(self, pump: Pump):
@@ -1681,10 +1678,6 @@ class SfincsAdapter(IHazardAdapter):
             else:
                 return spw_file
 
-        self.logger.info(
-            f"Creating spiderweb file for hurricane event `{name}`. This may take a while."
-        )
-
         # Initialize the tropical cyclone
         tc = TropicalCyclone()
         tc.read_track(filename=str(track_forcing.path), fmt="ddb_cyc")
@@ -1699,6 +1692,10 @@ class SfincsAdapter(IHazardAdapter):
         self.logger.info(f"{start} rainfall in the spiderweb file")
         tc.include_rainfall = include_rainfall
 
+        self.logger.info(
+            f"Creating spiderweb file for hurricane event `{name}`. This may take a while."
+        )
+
         # Create spiderweb file from the track
         tc.to_spiderweb(spw_file)
 
@@ -1843,13 +1840,7 @@ class SfincsAdapter(IHazardAdapter):
             waterlevel = df_gauge.iloc[:, 0] + gauge_reference_height
 
             # If data is available, add to plot
-            fig.add_trace(
-                go.Scatter(
-                    x=pd.DatetimeIndex(df_gauge.index),
-                    y=waterlevel,
-                    line_color="#ea6404",
-                )
-            )
+            fig.add_trace(px.line(waterlevel, color="#ea6404"))
             fig["data"][0]["name"] = "model"
             fig["data"][1]["name"] = "measurement"
             fig.update_layout(showlegend=True)

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/config/fiat.py

@@ -209,7 +209,7 @@ class FiatModel(BaseModel):
     config: FiatConfigModel
 
     benefits: Optional[BenefitsModel] = None
-    risk: Optional[RiskModel] = None
+    risk: Optional[RiskModel] = RiskModel()
 
     @staticmethod
     def read_toml(path: Path) -> "FiatModel":

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/config/site.py

@@ -66,6 +66,11 @@ class Site(BaseModel):
             "description": self.description,
             "lat": self.lat,
             "lon": self.lon,
+            "standard_objects": {
+                "events": self.standard_objects.events,
+                "projections": self.standard_objects.projections,
+                "strategies": self.standard_objects.strategies,
+            },
             "components": {},
         }
 

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/dbs_classes/database.py

@@ -14,7 +14,6 @@ from geopandas import GeoDataFrame
 from plotly.express import line
 from plotly.express.colors import sample_colorscale
 
-from flood_adapt.config.config import Settings
 from flood_adapt.config.site import Site
 from flood_adapt.dbs_classes.dbs_benefit import DbsBenefit
 from flood_adapt.dbs_classes.dbs_event import DbsEvent
@@ -123,11 +122,17 @@ class Database(IDatabase):
 
         # Initialize the different database objects
         self._static = DbsStatic(self)
-        self._events = DbsEvent(self)
+        self._events = DbsEvent(
+            self, standard_objects=self.site.standard_objects.events
+        )
         self._scenarios = DbsScenario(self)
-        self._strategies = DbsStrategy(self)
+        self._strategies = DbsStrategy(
+            self, standard_objects=self.site.standard_objects.strategies
+        )
         self._measures = DbsMeasure(self)
-        self._projections = DbsProjection(self)
+        self._projections = DbsProjection(
+            self, standard_objects=self.site.standard_objects.projections
+        )
         self._benefits = DbsBenefit(self)
 
         # Delete any unfinished/crashed scenario output
@@ -648,9 +653,6 @@ class Database(IDatabase):
             - does not have a corresponding input
 
         """
-        if not Settings().delete_crashed_runs:
-            return
-
         if not self.scenarios.output_path.is_dir():
             return
 

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/dbs_classes/dbs_event.py

@@ -33,26 +33,6 @@ class DbsEvent(DbsTemplate[Event]):
         # Load event
         return EventFactory.load_file(event_path)
 
-    def _check_standard_objects(self, name: str) -> bool:
-        """Check if an event is a standard event.
-
-        Parameters
-        ----------
-        name : str
-            name of the event to be checked
-
-        Returns
-        -------
-        bool
-            True if the event is a standard event, False otherwise
-        """
-        # Check if event is a standard event
-        if self._database.site.standard_objects:
-            if self._database.site.standard_objects.events:
-                if name in self._database.site.standard_objects.events:
-                    return True
-        return False
-
     def check_higher_level_usage(self, name: str) -> list[str]:
         """Check if an event is used in a scenario.
 

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/dbs_classes/dbs_projection.py

@@ -7,27 +7,6 @@ class DbsProjection(DbsTemplate[Projection]):
     display_name = "Projection"
     _object_class = Projection
 
-    def _check_standard_objects(self, name: str) -> bool:
-        """Check if a projection is a standard projection.
-
-        Parameters
-        ----------
-        name : str
-            name of the projection to be checked
-
-        Raises
-        ------
-        ValueError
-            Raise error if projection is a standard projection.
-        """
-        # Check if projection is a standard projection
-        if self._database.site.standard_objects:
-            if self._database.site.standard_objects.projections:
-                if name in self._database.site.standard_objects.projections:
-                    return True
-
-        return False
-
     def check_higher_level_usage(self, name: str) -> list[str]:
         """Check if a projection is used in a scenario.
 

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/dbs_classes/dbs_static.py

@@ -39,6 +39,20 @@ class DbsStatic(IDbsStatic):
         """Initialize any necessary attributes."""
         self._database = database
 
+    def load_static_data(self):
+        """Read data into the cache.
+
+        This is used to read data from the database and store it in the cache.
+        """
+        self.get_aggregation_areas()
+        self.get_model_boundary()
+        self.get_model_grid()
+        self.get_obs_points()
+        if self._database.site.sfincs.slr_scenarios is not None:
+            self.get_slr_scn_names()
+        self.get_buildings()
+        self.get_property_types()
+
     @cache_method_wrapper
     def get_aggregation_areas(self) -> dict[str, gpd.GeoDataFrame]:
         """Get a list of the aggregation areas that are provided in the site configuration.

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/dbs_classes/dbs_strategy.py

@@ -104,26 +104,6 @@ class DbsStrategy(DbsTemplate[Strategy]):
                     counter += 1
             raise ValueError(msg)
 
-    def _check_standard_objects(self, name: str) -> bool:
-        """Check if a strategy is a standard strategy.
-
-        Parameters
-        ----------
-        name : str
-            name of the strategy to be checked
-
-        Raises
-        ------
-        ValueError
-            Raise error if strategy is a standard strategy.
-        """
-        # Check if strategy is a standard strategy
-        if self._database.site.standard_objects:
-            if self._database.site.standard_objects.strategies:
-                if name in self._database.site.standard_objects.strategies:
-                    return True
-        return False
-
     def check_higher_level_usage(self, name: str) -> list[str]:
         """Check if a strategy is used in a scenario.
 

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/dbs_classes/dbs_template.py

@@ -1,7 +1,7 @@
 import shutil
 from datetime import datetime
 from pathlib import Path
-from typing import Any, TypeVar
+from typing import Any, Optional, TypeVar
 
 import tomli
 import tomli_w
@@ -18,12 +18,14 @@ class DbsTemplate(AbstractDatabaseElement[T_OBJECTMODEL]):
     dir_name: str
     _object_class: type[T_OBJECTMODEL]
 
-    def __init__(self, database: IDatabase):
+    def __init__(
+        self, database: IDatabase, standard_objects: Optional[list[str]] = None
+    ):
         """Initialize any necessary attributes."""
         self._database = database
         self.input_path = database.input_path / self.dir_name
         self.output_path = database.output_path / self.dir_name
-        self.standard_objects = []
+        self.standard_objects = standard_objects
 
     def get(self, name: str) -> T_OBJECTMODEL:
         """Return an object of the type of the database with the given name.
@@ -188,8 +190,8 @@ class DbsTemplate(AbstractDatabaseElement[T_OBJECTMODEL]):
         bool
             True if the object is a standard object, False otherwise
         """
-        # If this function is not implemented for the object type, it cannot be a standard object.
-        # By default, it is not a standard object.
+        if self.standard_objects:
+            return name in self.standard_objects
         return False
 
     def check_higher_level_usage(self, name: str) -> list[str]:

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt/flood_adapt.py

@@ -923,6 +923,13 @@ class FloodAdapt:
         )
 
     # Static
+    def load_static_data(self):
+        """Read the static data into the cache.
+
+        This is used to speed up the loading of the static data.
+        """
+        self.database.static.load_static_data()
+
     def get_aggregation_areas(
         self,
     ) -> dict[str, gpd.GeoDataFrame]:

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/flood_adapt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.6
+Version: 0.3.8
 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:                     GNU GENERAL PUBLIC LICENSE

{flood_adapt-0.3.6 → flood_adapt-0.3.8}/tests/test_flood_adapt.py

@@ -1,3 +1,5 @@
+import platform
+
 import geopandas as gpd
 import numpy as np
 import pandas as pd
@@ -272,6 +274,10 @@ class TestStrategies:
             test_fa.get_strategy(strategy.name)
 
 
+@pytest.mark.skipif(
+    platform.system() == "Linux",
+    reason="Skipped on Linux due to broken sfincs binary",
+)
 class TestScenarios:
     @pytest.fixture()
     def setup_nearshore_scenario(self, test_fa: FloodAdapt, setup_nearshore_event):
@@ -430,6 +436,10 @@ class TestScenarios:
         test_fa.database.scenarios.summarize_objects()
 
 
+@pytest.mark.skipif(
+    platform.system() == "Linux",
+    reason="Skipped on Linux due to broken sfincs binary",
+)
 class TestOutput:
     @pytest.fixture(scope="class")
     def completed_scenario(self, test_fa_class: FloodAdapt):