flood-adapt 1.1.2__tar.gz → 1.1.3__tar.gz

{flood_adapt-1.1.2 → flood_adapt-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 1.1.2
+Version: 1.1.3
 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.2 → flood_adapt-1.1.3}/flood_adapt/__init__.py

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

{flood_adapt-1.1.2 → flood_adapt-1.1.3}/flood_adapt/adapter/sfincs_adapter.py

@@ -677,23 +677,20 @@ 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 None:
+        obs_points = self.settings.obs_point
+        if not obs_points:
             return
-        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)
-
-        # create GeoDataFrame from obs_points in site file
+        names = [pt.name for pt in obs_points]
+        lat = [pt.lat for pt in obs_points]
+        lon = [pt.lon for pt in obs_points]
+
+        logger.info("Adding observation points to the overland flood model")
         df = pd.DataFrame({"name": names})
         gdf = gpd.GeoDataFrame(
-            df, geometry=gpd.points_from_xy(lon, lat), crs="EPSG:4326"
+            df,
+            geometry=gpd.points_from_xy(lon, lat),
+            crs="EPSG:4326",
         )
 
         # Add locations to SFINCS file

{flood_adapt-1.1.2 → flood_adapt-1.1.3}/flood_adapt/database_builder/__init__.py

@@ -10,6 +10,16 @@ from flood_adapt.database_builder.database_builder import (
     create_database,
 )
 
+from .metrics_utils import (
+    BuildingsInfographicModel,
+    EventInfographicModel,
+    HomesInfographicModel,
+    ImpactCategoriesModel,
+    MetricModel,
+    RiskInfographicModel,
+    RoadsInfographicModel,
+)
+
 __all__ = [
     "Basins",
     "ConfigModel",
@@ -20,4 +30,11 @@ __all__ = [
     "TideGaugeConfigModel",
     "UnitSystems",
     "create_database",
+    "BuildingsInfographicModel",
+    "EventInfographicModel",
+    "HomesInfographicModel",
+    "MetricModel",
+    "RiskInfographicModel",
+    "RoadsInfographicModel",
+    "ImpactCategoriesModel",
 ]

{flood_adapt-1.1.2 → flood_adapt-1.1.3}/flood_adapt/database_builder/database_builder.py

@@ -32,10 +32,15 @@ from flood_adapt.config.fiat import (
 from flood_adapt.config.gui import (
     AggregationDmgLayer,
     BenefitsLayer,
+    FieldName,
+    FilterCondition,
+    FilterGroup,
     FloodMapLayer,
     FootprintsDmgLayer,
     GuiModel,
     GuiUnitModel,
+    LogicalOperator,
+    MetricLayer,
     OutputLayers,
     PlottingModel,
     SyntheticTideModel,
@@ -70,6 +75,15 @@ from flood_adapt.config.site import (
     Site,
     StandardObjectModel,
 )
+from flood_adapt.database_builder.metrics_utils import (
+    BuildingsInfographicModel,
+    EventInfographicModel,
+    HomesInfographicModel,
+    MetricModel,
+    Metrics,
+    RiskInfographicModel,
+    RoadsInfographicModel,
+)
 from flood_adapt.dbs_classes.database import Database
 from flood_adapt.misc.debug_timer import debug_timer
 from flood_adapt.misc.log import FloodAdaptLogging
@@ -87,16 +101,6 @@ from flood_adapt.objects.projections.projections import (
 )
 from flood_adapt.objects.strategies.strategies import Strategy
 
-from .metrics_utils import (
-    BuildingsInfographicModel,
-    EventInfographicModel,
-    HomesInfographicModel,
-    MetricModel,
-    Metrics,
-    RiskInfographicModel,
-    RoadsInfographicModel,
-)
-
 logger = FloodAdaptLogging.getLogger("DatabaseBuilder")
 
 
@@ -130,16 +134,17 @@ def path_check(str_path: str, config_path: Optional[Path] = None) -> str:
 
 
 class SpatialJoinModel(BaseModel):
-    """Represents a spatial join model.
+    """
+    Model for representing a spatial join between geometries and tabular data.
 
-    Attributes
+    Parameters
     ----------
-    name : Optional[str], default None
-        The name of the model.
+    name : Optional[str]
+        Name of the spatial join (optional).
     file : str
-        The file associated with the model.
+        Path to the file containing the spatial data to join.
     field_name : str
-        The field name used for the spatial join.
+        Name of the field used for joining.
     """
 
     name: Optional[str] = None
@@ -148,14 +153,13 @@ class SpatialJoinModel(BaseModel):
 
 
 class UnitSystems(str, Enum):
-    """Enumeration for accepted values for the unit_system field.
+    """
+    Enumeration for supported unit systems.
 
-    Attributes
-    ----------
-    imperial : str
-        Represents the imperial unit system.
-    metric : str
-        Represents the metric unit system.
+    Values
+    ------
+    imperial : Imperial units (feet, miles, etc.)
+    metric : Metric units (meters, kilometers, etc.)
     """
 
     imperial = "imperial"
@@ -163,36 +167,30 @@ class UnitSystems(str, Enum):
 
 
 class FootprintsOptions(str, Enum):
-    """Enumeration for accepted values for the building_footprints field.
+    """
+    Enumeration for building footprints data sources.
 
-    Attributes
-    ----------
-    OSM : str
-        Use OpenStreetMap for building footprints.
+    Values
+    ------
+    OSM : Use OpenStreetMap for building footprints.
     """
 
     OSM = "OSM"
 
 
 class Basins(str, Enum):
-    """Enumeration class representing different basins.
+    """
+    Enumeration of global cyclone basins.
 
-    Attributes
-    ----------
-    NA : str
-        North Atlantic
-    SA : str
-        South Atlantic
-    EP : str
-        Eastern North Pacific (which includes the Central Pacific region)
-    WP : str
-        Western North Pacific
-    SP : str
-        South Pacific
-    SI : str
-        South Indian
-    NI : str
-        North Indian
+    Values
+    ------
+    NA : North Atlantic
+    SA : South Atlantic
+    EP : Eastern North Pacific (includes Central Pacific)
+    WP : Western North Pacific
+    SP : South Pacific
+    SI : South Indian
+    NI : North Indian
     """
 
     NA = "NA"
@@ -205,59 +203,67 @@ class Basins(str, Enum):
 
 
 class GuiConfigModel(BaseModel):
-    """Represents a GUI model for FloodAdapt.
+    """
+    Configuration for FloodAdapt GUI visualization scaling.
 
-    Attributes
+    Parameters
     ----------
     max_flood_depth : float
-        The last visualization bin will be ">value".
+        Maximum flood depth for visualization bins (last bin is ">value").
     max_aggr_dmg : float
-        The last visualization bin will be ">value".
+        Maximum aggregated damage for visualization bins.
     max_footprint_dmg : float
-        The last visualization bin will be ">value".
+        Maximum footprint damage for visualization bins.
     max_benefits : float
-        The last visualization bin will be ">value".
+        Maximum benefits for visualization bins.
+    additional_aggregated_layers : Optional[list[MetricLayer]]
+        Additional metric layers for aggregation (optional).
     """
 
     max_flood_depth: float
     max_aggr_dmg: float
     max_footprint_dmg: float
     max_benefits: float
+    additional_aggregated_layers: Optional[list[MetricLayer]] = None
 
 
 class SviConfigModel(SpatialJoinModel):
-    """Represents a model for the Social Vulnerability Index (SVI).
+    """
+    Model for Social Vulnerability Index (SVI) spatial join.
+
+    Inherits from SpatialJoinModel.
 
-    Attributes
+    Parameters
     ----------
     threshold : float
-        The threshold value for the SVI model to specify vulnerability.
+        Threshold value to specify vulnerability.
     """
 
     threshold: float
 
 
 class TideGaugeConfigModel(BaseModel):
-    """Represents a tide gauge model.
+    """
+    Model for tide gauge configuration.
 
-    Attributes
+    Parameters
     ----------
     source : TideGaugeSource
-        The source of the tide gauge data.
-    description : str, default ""
+        Source of tide gauge data.
+    description : str
         Description of the tide gauge.
-    ref : Optional[str], default None
-        The reference name. Should be defined in the water level references.
-    id : Optional[int], default None
-        The station ID.
-    lon : Optional[float], default None
-        Longitude of the tide gauge.
-    lat : Optional[float], default None
-        Latitude of the tide gauge.
-    file : Optional[str], default None
-        The file associated with the tide gauge data.
-    max_distance : Optional[us.UnitfulLength], default None
-        The maximum distance.
+    ref : Optional[str]
+        Reference name (should match water level references).
+    id : Optional[int]
+        Station ID.
+    lon : Optional[float]
+        Longitude.
+    lat : Optional[float]
+        Latitude.
+    file : Optional[str]
+        Path to tide gauge data file.
+    max_distance : Optional[us.UnitfulLength]
+        Maximum distance for gauge association.
     """
 
     source: TideGaugeSource
@@ -272,74 +278,76 @@ class TideGaugeConfigModel(BaseModel):
 
 class ConfigModel(BaseModel):
     """
-    Represents the configuration model for FloodAdapt.
+    Main configuration model for FloodAdapt database builder.
 
-    Attributes
+    Parameters
     ----------
     name : str
-        The name of the site.
-    description : Optional[str], default None
-        The description of the site.
-    database_path : Optional[str], default None
-        The path to the database where all the sites are located.
+        Name of the site (must be valid for folder names).
+    description : Optional[str]
+        Description of the site.
+    database_path : Optional[str]
+        Path to the database root directory.
     unit_system : UnitSystems
-        The unit system.
+        Unit system for all calculations (imperial or metric).
     gui : GuiConfigModel
-        The GUI model representing scaling values for the layers.
-    infographics : bool, default True
-        Indicates if infographics are enabled.
-    event_infographics : Optional[EventInfographicModel], default None
-        Event infographic configuration.
-    risk_infographics : Optional[RiskInfographicModel], default None
-        Risk infographic configuration.
-    event_additional_infometrics : Optional[list[MetricModel]], default None
+        GUI visualization scaling configuration.
+    infographics : bool
+        Enable/disable infographics.
+    event_infographics : Optional[EventInfographicModel]
+        Configuration for event infographics.
+    risk_infographics : Optional[RiskInfographicModel]
+        Configuration for risk infographics.
+    event_additional_infometrics : Optional[list[MetricModel]]
         Additional event infometrics.
-    risk_additional_infometrics : Optional[list[MetricModel]], default None
+    risk_additional_infometrics : Optional[list[MetricModel]]
         Additional risk infometrics.
     fiat : str
-        The FIAT model path.
-    aggregation_areas : Optional[list[SpatialJoinModel]], default None
-        The list of aggregation area models.
-    building_footprints : Optional[SpatialJoinModel | FootprintsOptions], default FootprintsOptions.OSM
-        The building footprints model or OSM option.
-    fiat_buildings_name : str | list[str], default "buildings"
-        The name(s) of the buildings geometry in the FIAT model.
-    fiat_roads_name : Optional[str], default "roads"
-        The name of the roads geometry in the FIAT model.
-    bfe : Optional[SpatialJoinModel], default None
-        The BFE model.
-    svi : Optional[SviConfigModel], default None
-        The SVI model.
-    road_width : us.UnitfulLength, default 5 meters
-        The road width.
-    return_periods : Optional[list[int]], default None
-        The list of return periods for risk calculations.
-    floodmap_type : Optional[FloodmapType], default None
-        The type of floodmap to use.
-    references : Optional[WaterlevelReferenceModel], default None
-        The water level reference model.
+        Path to the FIAT model directory.
+    aggregation_areas : Optional[list[SpatialJoinModel]]
+        List of aggregation area spatial join models.
+    building_footprints : Optional[SpatialJoinModel | FootprintsOptions]
+        Building footprints source or spatial join model.
+    fiat_buildings_name : str | list[str]
+        Name(s) of buildings geometry in FIAT model.
+    fiat_roads_name : Optional[str]
+        Name of roads geometry in FIAT model.
+    bfe : Optional[SpatialJoinModel]
+        Base Flood Elevation spatial join model.
+    svi : Optional[SviConfigModel]
+        Social Vulnerability Index spatial join model.
+    road_width : us.UnitfulLength
+        Road width (default 5 meters).
+    return_periods : Optional[list[int]]
+        List of return periods for risk calculations.
+    floodmap_type : Optional[FloodmapType]
+        Type of floodmap to use.
+    references : Optional[WaterlevelReferenceModel]
+        Water level reference model.
     sfincs_overland : FloodModel
-        The overland SFINCS model.
-    sfincs_offshore : Optional[FloodModel], default None
-        The offshore SFINCS model.
-    dem : Optional[DemModel], default None
-        The DEM model.
-    excluded_datums : list[str], default []
+        Overland SFINCS model configuration.
+    sfincs_offshore : Optional[FloodModel]
+        Offshore SFINCS model configuration.
+    dem : Optional[DemModel]
+        Digital Elevation Model configuration.
+    river_names : Optional[list[str]]
+        List of river names (optional).
+    excluded_datums : list[str]
         List of datums to exclude from plotting.
-    slr_scenarios : Optional[SlrScenariosModel], default None
-        The sea level rise scenarios model.
-    scs : Optional[SCSModel], default None
-        The SCS model.
-    tide_gauge : Optional[TideGaugeConfigModel], default None
-        The tide gauge model.
-    cyclones : Optional[bool], default True
-        Indicates if cyclones are enabled.
-    cyclone_basin : Optional[Basins], default None
-        The cyclone basin.
-    obs_point : Optional[list[ObsPointModel]], default None
-        The list of observation point models.
-    probabilistic_set : Optional[str], default None
-        The probabilistic set path.
+    slr_scenarios : Optional[SlrScenariosModel]
+        Sea level rise scenarios configuration.
+    scs : Optional[SCSModel]
+        SCS model configuration.
+    tide_gauge : Optional[TideGaugeConfigModel]
+        Tide gauge configuration.
+    cyclones : Optional[bool]
+        Enable/disable cyclones.
+    cyclone_basin : Optional[Basins]
+        Cyclone basin selection.
+    obs_point : Optional[list[ObsPointModel]]
+        List of observation point models.
+    probabilistic_set : Optional[str]
+        Path to probabilistic event set.
     """
 
     # General
@@ -375,7 +383,7 @@ class ConfigModel(BaseModel):
     sfincs_overland: FloodModel
     sfincs_offshore: Optional[FloodModel] = None
     dem: Optional[DemModel] = None
-
+    river_names: Optional[list[str]] = None
     excluded_datums: list[str] = Field(default_factory=list)
 
     slr_scenarios: Optional[SlrScenariosModel] = None
@@ -1347,7 +1355,12 @@ class DatabaseBuilder:
         if delete_sfincs_folder:
             gc.collect()
             if subgrid_sfincs_folder.exists() and subgrid_sfincs_folder.is_dir():
-                shutil.rmtree(subgrid_sfincs_folder)
+                try:
+                    shutil.rmtree(subgrid_sfincs_folder)
+                except Exception:
+                    logger.warning(
+                        f"Could not delete temporary SFINCS subgrid folder at {subgrid_sfincs_folder.as_posix()}."
+                    )
 
         return DemModel(
             filename=fa_subgrid_path.name, units=us.UnitTypesLength.meters
@@ -1393,39 +1406,43 @@ class DatabaseBuilder:
         else:
             logger.info("Observation points were provided in the config file.")
             obs_points = self.config.obs_point
+
         if self.tide_gauge is not None:
-            # Check if the tide gauge point is within the SFINCS region
-            region = self.sfincs_overland_model.region
-            point = gpd.GeoSeries(
-                [gpd.points_from_xy([self.tide_gauge.lon], [self.tide_gauge.lat])[0]],
-                crs=4326,
-            )
-            region_4326 = region.to_crs(4326)
-            if not point.within(region_4326.unary_union).item():
-                logger.warning(
-                    "The tide gauge location is outside the SFINCS region and will not be added as an observation point."
-                )
-            else:
-                logger.info(
-                    "A tide gauge has been setup in the database. It will be used as an observation point as well."
-                )
-                obs_points.append(
-                    ObsPointModel(
-                        name=self.tide_gauge.name,
-                        description="Tide gauge observation point",
-                        ID=self.tide_gauge.ID,
-                        lon=self.tide_gauge.lon,
-                        lat=self.tide_gauge.lat,
-                    )
+            logger.info(
+                "A tide gauge has been setup in the database. It will be used as an observation point as well."
+            )
+            obs_points.append(
+                ObsPointModel(
+                    name=self.tide_gauge.name,
+                    description="Tide gauge observation point",
+                    ID=self.tide_gauge.ID,
+                    lon=self.tide_gauge.lon,
+                    lat=self.tide_gauge.lat,
                 )
+            )
 
         if not obs_points:
             logger.warning(
                 "No observation points were provided in the config file or created from the tide gauge. No observation points will be available in FloodAdapt."
             )
             return None
-        else:
-            return obs_points
+
+        lon = [p.lon for p in obs_points]
+        lat = [p.lat for p in obs_points]
+        names = [p.name for p in obs_points]
+        coords = gpd.GeoDataFrame(
+            {"names": names},
+            geometry=gpd.points_from_xy(lon, lat),
+            crs="EPSG:4326",
+        )
+        coords = coords.to_crs(self.sfincs_overland_model.crs)
+        model_region = self.sfincs_overland_model.region.union_all()
+        valid_coords = coords.within(model_region)
+        if not valid_coords.all():
+            invalid = coords.loc[~valid_coords, "name"].tolist()
+            raise ValueError(f"Observation points outside model domain: {invalid}")
+
+        return obs_points
 
     @debug_timer
     def create_rivers(self) -> list[RiverModel]:
@@ -1440,6 +1457,17 @@ class DatabaseBuilder:
             geometry=gpd.points_from_xy(df.x, df.y),
             crs=self.sfincs_overland_model.crs,
         )
+
+        if self.config.river_names:
+            if len(self.config.river_names) != len(river_locs):
+                msg = "The number of river names provided does not match the number of rivers found in the SFINCS model."
+                logger.error(msg)
+                raise ValueError(msg)
+            else:
+                river_locs["name"] = self.config.river_names
+        else:
+            river_locs["name"] = [f"river_{idx}" for idx in range(len(river_locs))]
+
         rivers = []
         for idx, row in river_locs.iterrows():
             if "dis" in self.sfincs_overland_model.forcing:
@@ -1456,7 +1484,7 @@ class DatabaseBuilder:
                 )
 
             river = RiverModel(
-                name=f"river_{idx}",
+                name=row["name"],
                 x_coordinate=row.x,
                 y_coordinate=row.y,
                 mean_discharge=us.UnitfulDischarge(
@@ -1782,6 +1810,69 @@ class DatabaseBuilder:
                 ],
                 threshold=0.0,
             )
+        red_colors_6 = [
+            "#FFFFFF",
+            "#FEE9CE",
+            "#FDBB84",
+            "#FC844E",
+            "#E03720",
+            "#860000",
+        ]
+
+        aggregated_metrics = []
+
+        building_count = MetricLayer(
+            type="building_count",
+            bins=[1, 10, 50, 200, 500],  # TODO provide max values
+            colors=red_colors_6,
+            filters=FilterGroup(
+                conditions=[
+                    FilterCondition(
+                        field_name=FieldName.NAME,
+                        values=["Count"],
+                    ),
+                    FilterCondition(
+                        field_name=FieldName.LONG_NAME,
+                        values=["(#)"],
+                    ),
+                ],
+                operator=LogicalOperator.OR,
+            ),
+        )
+        aggregated_metrics.append(building_count)
+
+        if self.config.gui.additional_aggregated_layers:
+            aggregated_metrics.extend(self.config.gui.additional_aggregated_layers)
+
+        if self._has_roads:
+            bins = [0.0001, 1, 5, 10, 20]  # in kms
+            if self.unit_system == GuiUnitModel.imperial():
+                # convert to miles
+                bins = [
+                    us.UnitfulLength(value=b * 1000, units=us.UnitTypesLength.meters)
+                    .transform(us.UnitTypesLength.miles)
+                    .value
+                    for b in bins
+                ]
+            roads_length = MetricLayer(
+                type="road_length",
+                bins=bins,  # TODO provide max values
+                colors=red_colors_6,
+                filters=FilterGroup(
+                    conditions=[
+                        FilterCondition(
+                            field_name=FieldName.NAME,
+                            values=["RoadsLength"],
+                        ),
+                        FilterCondition(
+                            field_name=FieldName.LONG_NAME,
+                            values=["roads"],
+                        ),
+                    ],
+                    operator=LogicalOperator.AND,
+                ),
+            )
+            aggregated_metrics.append(roads_length)
 
         output_layers = OutputLayers(
             floodmap=FloodMapLayer(
@@ -1792,25 +1883,12 @@ class DatabaseBuilder:
             ),
             aggregation_dmg=AggregationDmgLayer(
                 bins=[0.00001, 0.1 * ad_max, 0.25 * ad_max, 0.5 * ad_max, ad_max],
-                colors=[
-                    "#FFFFFF",
-                    "#FEE9CE",
-                    "#FDBB84",
-                    "#FC844E",
-                    "#E03720",
-                    "#860000",
-                ],
+                colors=red_colors_6,
             ),
+            aggregated_metrics=aggregated_metrics,
             footprints_dmg=FootprintsDmgLayer(
                 bins=[0.00001, 0.06 * ftd_max, 0.2 * ftd_max, 0.4 * ftd_max, ftd_max],
-                colors=[
-                    "#FFFFFF",
-                    "#FEE9CE",
-                    "#FDBB84",
-                    "#FC844E",
-                    "#E03720",
-                    "#860000",
-                ],
+                colors=red_colors_6,
             ),
             benefits=benefits_layer,
         )
@@ -1893,6 +1971,8 @@ class DatabaseBuilder:
         # Write the metrics config files
         self._write_infometrics(metrics, path_im, path_ig)
 
+        self.metrics = metrics
+
     def _create_mandatory_metrics(self, metrics):
         metrics.create_mandatory_metrics_event()
         if self._probabilistic_set_name is not None: