flood-adapt 0.3.12__py3-none-any.whl → 0.3.13__py3-none-any.whl

flood_adapt/__init__.py

@@ -1,10 +1,9 @@
 # has to be here at the start to avoid circular imports
-__version__ = "0.3.12"
+__version__ = "0.3.13"
 
-from flood_adapt import adapter, dbs_classes, objects
+from flood_adapt import adapter, database_builder, dbs_classes, objects
 from flood_adapt.config.config import Settings
 from flood_adapt.config.site import Site
-from flood_adapt.database_builder.database_builder import DatabaseBuilder
 from flood_adapt.flood_adapt import FloodAdapt
 from flood_adapt.misc.exceptions import ComponentError, DatabaseError, FloodAdaptError
 from flood_adapt.misc.log import FloodAdaptLogging
@@ -19,10 +18,10 @@ __all__ = [
     "objects",
     "dbs_classes",
     "adapter",
+    "database_builder",
     "FloodAdaptError",
     "DatabaseError",
     "ComponentError",
-    "DatabaseBuilder",
 ]
 
 FloodAdaptLogging()  # Initialize logging once for the entire package

flood_adapt/adapter/fiat_adapter.py

@@ -880,6 +880,15 @@ class FiatAdapter(IImpactAdapter):
             for aggr in self.config.aggregation
         ]
         new_dev_geom_name = Path(self.config.new_development_file_name).stem
+        # Ensure new_devs geom is in the correct CRS
+        new_dev_geom = gpd.read_file(area_path)
+        if new_dev_geom.crs != self.model.exposure.crs:
+            self.logger.warning(
+                f"New development area geometries are in {new_dev_geom.crs}, but the model is in {self.model.exposure.crs}. Reprojecting geometries."
+            )
+            new_dev_geom = new_dev_geom.to_crs(self.model.exposure.crs)
+        # Replace file with the reprojected one
+        new_dev_geom.to_file(area_path, driver="GPKG", mode="w")
         # Use hydromt function
         self.model.exposure.setup_new_composite_areas(
             percent_growth=population_growth,

flood_adapt/adapter/sfincs_adapter.py

@@ -675,7 +675,10 @@ class SfincsAdapter(IHazardAdapter):
             )
 
             event = self.database.events.get(scenario.event)
-            if self.settings.obs_point[ii].name == self.settings.tide_gauge.name:
+            if (
+                self.settings.tide_gauge is not None
+                and 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

flood_adapt/database_builder/__init__.py

@@ -0,0 +1,23 @@
+from flood_adapt.database_builder.database_builder import (
+    Basins,
+    ConfigModel,
+    FootprintsOptions,
+    GuiConfigModel,
+    SpatialJoinModel,
+    SviConfigModel,
+    TideGaugeConfigModel,
+    UnitSystems,
+    create_database,
+)
+
+__all__ = [
+    "Basins",
+    "ConfigModel",
+    "FootprintsOptions",
+    "GuiConfigModel",
+    "SpatialJoinModel",
+    "SviConfigModel",
+    "TideGaugeConfigModel",
+    "UnitSystems",
+    "create_database",
+]

flood_adapt/database_builder/database_builder.py

@@ -2,6 +2,7 @@ import datetime
 import logging
 import math
 import os
+import re
 import shutil
 import time
 import warnings
@@ -108,19 +109,24 @@ def debug_timer(func):
 
 
 def path_check(str_path: str, config_path: Optional[Path] = None) -> str:
-    """
-    Check if the given path is absolute and return the absolute path.
+    """Check if the given path is absolute and return the absolute path.
 
-    Args:
-        path (str): The path to be checked.
+    Parameters
+    ----------
+    str_path : str
+        The path to be checked.
+    config_path : Optional[Path], default None
+        The base path to resolve relative paths.
 
     Returns
     -------
-        str: The absolute path.
+    str
+        The absolute path as a string.
 
     Raises
     ------
-        ValueError: If the path is not absolute and no config_path is provided.
+    ValueError
+        If the path is not absolute and no config_path is provided.
     """
     path = Path(str_path)
     if not path.is_absolute():
@@ -132,14 +138,16 @@ def path_check(str_path: str, config_path: Optional[Path] = None) -> str:
 
 
 class SpatialJoinModel(BaseModel):
-    """
-    Represents a spatial join model.
+    """Represents a spatial join model.
 
     Attributes
     ----------
-    name (Optional[str]): The name of the model (optional).
-    file (str): The file associated with the model.
-    field_name (str): The field name used for the spatial join.
+    name : Optional[str], default None
+        The name of the model.
+    file : str
+        The file associated with the model.
+    field_name : str
+        The field name used for the spatial join.
     """
 
     name: Optional[str] = None
@@ -148,14 +156,14 @@ class SpatialJoinModel(BaseModel):
 
 
 class UnitSystems(str, Enum):
-    """The `UnitSystems` class is an enumeration that represents the accepted values for the `metric_system` field.
-
-    It provides two options: `imperial` and `metric`.
+    """Enumeration for accepted values for the unit_system field.
 
     Attributes
     ----------
-        imperial (str): Represents the imperial unit system.
-        metric (str): Represents the metric unit system.
+    imperial : str
+        Represents the imperial unit system.
+    metric : str
+        Represents the metric unit system.
     """
 
     imperial = "imperial"
@@ -163,24 +171,36 @@ class UnitSystems(str, Enum):
 
 
 class FootprintsOptions(str, Enum):
+    """Enumeration for accepted values for the building_footprints field.
+
+    Attributes
+    ----------
+    OSM : str
+        Use OpenStreetMap for building footprints.
+    """
+
     OSM = "OSM"
 
 
 class Basins(str, Enum):
-    """
-    Enumeration class representing different basins.
-
-    Each basin is represented by a string value.
+    """Enumeration class representing different 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
+    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
     """
 
     NA = "NA"
@@ -193,15 +213,18 @@ class Basins(str, Enum):
 
 
 class GuiConfigModel(BaseModel):
-    """
-    Represents a GUI model for for FloodAdapt.
+    """Represents a GUI model for FloodAdapt.
 
     Attributes
     ----------
-        max_flood_depth (float): The last visualization bin will be ">value".
-        max_aggr_dmg (float): The last visualization bin will be ">value".
-        max_footprint_dmg (float): The last visualization bin will be ">value".
-        max_benefits (float): The last visualization bin will be ">value".
+    max_flood_depth : float
+        The last visualization bin will be ">value".
+    max_aggr_dmg : float
+        The last visualization bin will be ">value".
+    max_footprint_dmg : float
+        The last visualization bin will be ">value".
+    max_benefits : float
+        The last visualization bin will be ">value".
     """
 
     max_flood_depth: float
@@ -211,32 +234,38 @@ class GuiConfigModel(BaseModel):
 
 
 class SviConfigModel(SpatialJoinModel):
-    """
-    Represents a model for the Social Vulnerability Index (SVI).
+    """Represents a model for the Social Vulnerability Index (SVI).
 
     Attributes
     ----------
-        threshold (float): The threshold value for the SVI model to specify vulnerability.
+    threshold : float
+        The threshold value for the SVI model to specify vulnerability.
     """
 
     threshold: float
 
 
-class Point(BaseModel):
-    lat: float
-    lon: float
-
-
 class TideGaugeConfigModel(BaseModel):
-    """
-    Represents a tide gauge model.
+    """Represents a tide gauge model.
 
     Attributes
     ----------
-        source (str): The source of the tide gauge data.
-        file (Optional[str]): The file associated with the tide gauge data (default: None).
-        max_distance (Optional[float]): The maximum distance (default: None).
-        ref (str): The reference name. Should be defined in the water level references.
+    source : TideGaugeSource
+        The source of the tide gauge data.
+    description : str, default ""
+        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.
     """
 
     source: TideGaugeSource
@@ -249,21 +278,8 @@ class TideGaugeConfigModel(BaseModel):
     max_distance: Optional[us.UnitfulLength] = None
 
 
-class SviModel(SpatialJoinModel):
-    """
-    Represents a model for the Social Vulnerability Index (SVI).
-
-    Attributes
-    ----------
-        threshold (float): The threshold value for the SVI model to specify vulnerability.
-    """
-
-    threshold: float
-
-
 class ConfigModel(BaseModel):
-    """
-    Represents the configuration model for FloodAdapt.
+    """Represents the configuration model for FloodAdapt.
 
     Attributes
     ----------
@@ -285,8 +301,8 @@ class ConfigModel(BaseModel):
         The list of aggregation area models.
     building_footprints : Optional[SpatialJoinModel | FootprintsOptions], default FootprintsOptions.OSM
         The building footprints model or OSM option.
-    fiat_buildings_name : Optional[str], default "buildings"
-        The name of the buildings geometry in the FIAT model.
+    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
@@ -343,21 +359,14 @@ class ConfigModel(BaseModel):
     fiat_roads_name: Optional[str] = "roads"
     bfe: Optional[SpatialJoinModel] = None
     svi: Optional[SviConfigModel] = None
-    road_width: Optional[float] = 5
+    road_width: us.UnitfulLength = us.UnitfulLength(
+        value=5.0, units=us.UnitTypesLength.meters
+    )
     return_periods: list[int] = Field(default_factory=list)
     floodmap_type: Optional[FloodmapType] = None
 
     # SFINCS
-    references: WaterlevelReferenceModel = WaterlevelReferenceModel(
-        reference="MSL",
-        datums=[
-            DatumModel(
-                name="MSL",
-                height=us.UnitfulLength(value=0.0, units=us.UnitTypesLength.meters),
-            ),
-        ],
-    )
-
+    references: Optional[WaterlevelReferenceModel] = None
     sfincs_overland: FloodModel
     sfincs_offshore: Optional[FloodModel] = None
     dem: Optional[DemModel] = None
@@ -373,17 +382,18 @@ class ConfigModel(BaseModel):
     probabilistic_set: Optional[str] = None
 
     @staticmethod
-    def read(toml_path: Path) -> "ConfigModel":
+    def read(toml_path: Union[str, Path]) -> "ConfigModel":
         """
         Read a configuration file and returns the validated attributes.
 
         Args:
-            config (str): The path to the configuration file.
+            toml_path (str | Path): The path to the configuration file.
 
         Returns
         -------
             ConfigModel: The validated attributes from the configuration file.
         """
+        toml_path = Path(toml_path)
         with open(toml_path, mode="rb") as fp:
             toml = tomli.load(fp)
         config = ConfigModel.model_validate(toml)
@@ -428,7 +438,7 @@ class DatabaseBuilder:
     _aggregation_areas: Optional[list] = None
     _probabilistic_set_name: Optional[str] = None
 
-    def __init__(self, config: ConfigModel, overwrite: bool = True):
+    def __init__(self, config: ConfigModel):
         self.config = config
 
         # Set database root
@@ -442,9 +452,6 @@ class DatabaseBuilder:
         # Read info that needs to be used to create other models
         self.unit_system = self.create_default_units()
 
-        # Read info that needs to be updated with other model info
-        self.water_level_references = self.config.references
-
     @property
     def static_path(self) -> Path:
         return self.root / "static"
@@ -495,6 +502,9 @@ class DatabaseBuilder:
         self.read_template_sfincs_overland_model()
         self.read_template_sfincs_offshore_model()
 
+        # Copy standard static files
+        self.add_static_files()
+
     @debug_timer
     def set_standard_objects(self):
         # Define name and create object
@@ -787,13 +797,12 @@ class DatabaseBuilder:
         self.fiat_model.exposure.exposure_db = exposure
 
     def read_damage_unit(self) -> str:
-        if self.fiat_model.exposure.damage_unit is not None:
-            return self.fiat_model.exposure.damage_unit
-        else:
+        if self.fiat_model.exposure.damage_unit is None:
             logger.warning(
                 "Delft-FIAT model was missing damage units so '$' was assumed."
             )
-            return "$"
+            self.fiat_model.exposure.damage_unit = "$"
+        return self.fiat_model.exposure.damage_unit
 
     @debug_timer
     def read_floodmap_type(self) -> FloodmapType:
@@ -833,9 +842,8 @@ class DatabaseBuilder:
         # TODO should this should be performed through hydromt-FIAT?
         if not isinstance(roads.geometry.iloc[0], Polygon):
             roads = roads.to_crs(roads.estimate_utm_crs())
-            roads.geometry = roads.geometry.buffer(
-                self.config.road_width / 2, cap_style=2
-            )
+            road_width = self.config.road_width.convert(us.UnitTypesLength.meters)
+            roads.geometry = roads.geometry.buffer(road_width / 2, cap_style=2)
             roads = roads.to_crs(self.fiat_model.exposure.crs)
             self.fiat_model.exposure.exposure_geoms[self._get_fiat_road_index()] = roads
             logger.info(
@@ -1028,9 +1036,10 @@ class DatabaseBuilder:
                     aggr_name = Path(aggr.file).stem
                 # If aggregation area already in FIAT model raise Error
                 if aggr_name in [aggr.name for aggr in aggregation_areas]:
-                    raise ValueError(
-                        f"Aggregation area '{aggr_name}' already exists in the FIAT model."
+                    logger.warning(
+                        f"Aggregation area '{aggr_name}' already exists in the FIAT model. The input aggregation area will be ignored."
                     )
+                    continue
                 # Do spatial join of FIAT objects and aggregation areas
                 exposure_csv = self.fiat_model.exposure.exposure_db
                 gdf = self._get_fiat_gdf_full()
@@ -1039,6 +1048,7 @@ class DatabaseBuilder:
                     layer=str(self._check_exists_and_absolute(aggr.file)),
                     field_name=aggr.field_name,
                     rename=_FIAT_COLUMNS.aggregation_label.format(name=aggr_name),
+                    filter=True,
                 )
                 aggr_path = Path(self.fiat_model.root).joinpath(
                     "exposure", "aggregation_areas", f"{Path(aggr.file).stem}.gpkg"
@@ -1072,6 +1082,9 @@ class DatabaseBuilder:
                         ),
                     )
                 )
+                logger.info(
+                    f"Aggregation areas: {aggr_name} provided in the config are going to be used."
+                )
 
         # No config provided, no aggr areas in the model -> try to use the region file as a mock aggregation area
         if (
@@ -1183,7 +1196,8 @@ class DatabaseBuilder:
     def create_sfincs_config(self) -> SfincsModel:
         # call these functions before others to make sure water level references are updated
         config = self.create_sfincs_model_config()
-        tide_gauge = self.create_tide_gauge()
+        self.water_level_references = self.create_water_level_references()
+        self.tide_gauge = self.create_tide_gauge()
 
         sfincs = SfincsModel(
             config=config,
@@ -1192,13 +1206,42 @@ class DatabaseBuilder:
             dem=self.create_dem_model(),
             scs=self.create_scs_model(),
             cyclone_track_database=self.create_cyclone_track_database(),
-            tide_gauge=tide_gauge,
+            tide_gauge=self.tide_gauge,
             river=self.create_rivers(),
             obs_point=self.create_observation_points(),
         )
 
         return sfincs
 
+    @debug_timer
+    def create_water_level_references(self) -> WaterlevelReferenceModel:
+        sfincs_ref = self.config.sfincs_overland.reference
+        if self.config.references is None:
+            logger.warning(
+                f"No water level references provided in the config file. Using reference provided for overland SFINCS model '{sfincs_ref}' as the main reference."
+            )
+            refs = WaterlevelReferenceModel(
+                reference=sfincs_ref,
+                datums=[
+                    DatumModel(
+                        name=sfincs_ref,
+                        height=us.UnitfulLength(
+                            value=0.0, units=self.unit_system.default_length_units
+                        ),
+                    )
+                ],
+            )
+        else:
+            # Check if sfincs_ref is in the references
+            if sfincs_ref not in [ref.name for ref in self.config.references.datums]:
+                raise ValueError(
+                    f"Reference '{sfincs_ref}' not found in the provided references."
+                )
+            else:
+                refs = self.config.references
+
+        return refs
+
     @debug_timer
     def create_cyclone_track_database(self) -> Optional[CycloneTrackDatabaseModel]:
         if not self.config.cyclones or not self.config.sfincs_offshore:
@@ -1219,7 +1262,9 @@ class DatabaseBuilder:
         try:
             urlretrieve(url, fn)
         except Exception:
-            raise RuntimeError(f"Could not retrieve cyclone track database from {url}")
+            logger.warning(f"Could not retrieve cyclone track database from {url}")
+            logger.warning("No cyclones will be available in the database.")
+            return None
 
         return CycloneTrackDatabaseModel(file=name)
 
@@ -1315,10 +1360,43 @@ class DatabaseBuilder:
     @debug_timer
     def create_observation_points(self) -> Union[list[ObsPointModel], None]:
         if self.config.obs_point is None:
-            return None
+            obs_points = []
+        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("Observation points were provided in the config file.")
-        return self.config.obs_point
+        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
 
     @debug_timer
     def create_rivers(self) -> list[RiverModel]:
@@ -1370,9 +1448,6 @@ class DatabaseBuilder:
             logger.warning(
                 "Tide gauge information not provided. Historical events will not have an option to use gauged data in FloodAdapt!"
             )
-            logger.warning(
-                "No water level references were found. It is assumed that MSL is equal to the datum used in the SFINCS overland model. You can provide these values with the tide_gauge.ref attribute in the site.toml."
-            )
             return None
 
         if self.config.tide_gauge.source == TideGaugeSource.file:
@@ -1382,9 +1457,16 @@ class DatabaseBuilder:
                 )
             if self.config.tide_gauge.ref is None:
                 logger.warning(
-                    "Tide gauge reference not provided. MSL is assumed as the reference of the water levels in the file."
+                    f"Tide gauge reference not provided. '{self.water_level_references.reference}' is assumed as the reference of the water levels in the file."
                 )
-                self.config.tide_gauge.ref = "MSL"
+                self.config.tide_gauge.ref = self.water_level_references.reference
+            else:
+                if self.config.tide_gauge.ref not in [
+                    datum.name for datum in self.water_level_references.datums
+                ]:
+                    raise ValueError(
+                        f"Provided tide gauge reference '{self.config.tide_gauge.ref}' not found in the water level references!"
+                    )
 
             tide_gauge_file = self._check_exists_and_absolute(
                 self.config.tide_gauge.file
@@ -1416,10 +1498,6 @@ class DatabaseBuilder:
             else:
                 ref = "MLLW"  # If reference is not provided use MLLW
 
-            self.water_level_references.reference = (
-                ref  # update the water level reference
-            )
-
             if self.config.tide_gauge.id is None:
                 station_id = self._get_closest_station()
                 logger.info(
@@ -1432,6 +1510,80 @@ class DatabaseBuilder:
                 )
             station = self._get_station_metadata(station_id=station_id, ref=ref)
             if station is not None:
+                # First create water level references based on station
+                # Get datums
+                datums = []
+                # Get local datum
+                datums.append(
+                    DatumModel(
+                        name=station["datum_name"],
+                        height=us.UnitfulLength(
+                            value=station["datum"], units=station["units"]
+                        ).transform(self.unit_system.default_length_units),
+                    )
+                )
+                # Get MSL
+                datums.append(
+                    DatumModel(
+                        name="MSL",
+                        height=us.UnitfulLength(
+                            value=station["msl"], units=station["units"]
+                        ).transform(self.unit_system.default_length_units),
+                    )
+                )
+                # Get extras
+                for name in ["MLLW", "MHHW"]:
+                    height = us.UnitfulLength(
+                        value=station[name.lower()], units=station["units"]
+                    ).transform(self.unit_system.default_length_units)
+
+                    wl_info = DatumModel(
+                        name=name,
+                        height=height,
+                    )
+                    datums.append(wl_info)
+
+                station_refs = WaterlevelReferenceModel(reference=ref, datums=datums)
+
+                # Check if we can translate the rest of the datums
+                if self.water_level_references.reference != station_refs.reference:
+                    for dat in self.water_level_references.datums:
+                        if dat.name not in [
+                            datum.name for datum in station_refs.datums
+                        ]:
+                            # If datum is not in the datums, try to convert it
+                            h1 = dat.height
+                            ref1 = self.water_level_references.reference
+                            h2 = h1 + station_refs.get_datum(ref1).height
+                            # Replace the datum in self.water_level_references.datums
+                            dat.height = h2
+                            logger.warning(
+                                f"Datum '{dat.name}' converted to reference '{ref1}' with new height {h2}."
+                            )
+
+                # Check if datums already exist in the water level references and replace
+                for datum in datums:
+                    existing_datum = next(
+                        (
+                            dat
+                            for dat in self.water_level_references.datums
+                            if dat.name == datum.name
+                        ),
+                        None,
+                    )
+                    if existing_datum:
+                        self.water_level_references.datums.remove(existing_datum)
+                        logger.warning(
+                            f"Datum '{datum.name}' already exists in config reference. Replacing it based on NOAA station data."
+                        )
+                    self.water_level_references.datums.append(datum)
+
+                # Update reference datum
+                self.water_level_references.reference = (
+                    ref  # update the water level reference
+                )
+                logger.warning(f"Main water level reference set to '{ref}'.")
+
                 # Add tide_gauge information in site toml
                 tide_gauge = TideGauge(
                     name=station["name"],
@@ -1444,43 +1596,6 @@ class DatabaseBuilder:
                     units=us.UnitTypesLength.meters,  # the api always asks for SI units right now
                 )
 
-                local_datum = DatumModel(
-                    name=station["datum_name"],
-                    height=us.UnitfulLength(
-                        value=station["datum"], units=station["units"]
-                    ).transform(self.unit_system.default_length_units),
-                )
-                self.water_level_references.datums.append(local_datum)
-
-                msl = DatumModel(
-                    name="MSL",
-                    height=us.UnitfulLength(
-                        value=station["msl"], units=station["units"]
-                    ).transform(self.unit_system.default_length_units),
-                )
-                #  Check if MSL is already there and if yes replace it
-                existing_msl = next(
-                    (
-                        datum
-                        for datum in self.water_level_references.datums
-                        if datum.name == "MSL"
-                    ),
-                    None,
-                )
-                if existing_msl:
-                    self.water_level_references.datums.remove(existing_msl)
-                self.water_level_references.datums.append(msl)
-
-                for name in ["MLLW", "MHHW"]:
-                    height = us.UnitfulLength(
-                        value=station[name.lower()], units=station["units"]
-                    ).transform(self.unit_system.default_length_units)
-
-                    wl_info = DatumModel(
-                        name=name,
-                        height=height,
-                    )
-                    self.water_level_references.datums.append(wl_info)
             return tide_gauge
         else:
             logger.warning(
@@ -1843,6 +1958,33 @@ class DatabaseBuilder:
             path_1 = self.static_path / folder
             shutil.copytree(path_0, path_1)
 
+        # Check table values
+        green_infra_path = (
+            self.static_path / "green_infra_table" / "green_infra_lookup_table.csv"
+        )
+        df = pd.read_csv(green_infra_path)
+        # Convert "Infiltration depth (feet)" to the database unit system and rename column
+        # Find the column that has "Infiltration depth" in its name
+        infiltration_col = next(
+            (col for col in df.columns if "Infiltration depth" in col), None
+        )
+        # Try to infer the units from the column name, e.g., "Infiltration depth (feet)"
+        match = re.search(r"\((.*?)\)", infiltration_col)
+        current_units = match.group(1).strip()
+
+        # Determine target units and column name
+        if self.unit_system.default_length_units != current_units:
+            target_units = self.unit_system.default_length_units
+            new_col = f"Infiltration depth ({target_units.value})"
+            conversion_factor = us.UnitfulLength(
+                value=1.0, units=current_units
+            ).convert(target_units)
+
+            df[new_col] = (df[infiltration_col] * conversion_factor).round(2)
+            df = df.drop(columns=[infiltration_col])
+            # Save the updated table
+            df.to_csv(green_infra_path, index=False)
+
     @debug_timer
     def add_probabilistic_set(self):
         # Copy prob set if given
@@ -1993,7 +2135,8 @@ class DatabaseBuilder:
 
         Parameters
         ----------
-        None
+        clip_footprints : bool, default True
+            Whether to clip the building footprints to the hazard area.
 
         Returns
         -------
@@ -2159,6 +2302,7 @@ class DatabaseBuilder:
         Find the closest tide gauge station to the SFINCS domain and retrieves its metadata.
 
         Args:
+            station_id (str): The ID of the tide gauge station.
             ref (str, optional): The reference level for water level measurements. Defaults to "MLLW".
 
         Returns
@@ -2205,7 +2349,7 @@ class DatabaseBuilder:
         )
 
         logger.info(
-            f"The station metadata will be used to fill in the water_level attribute in the site.toml. The reference level will be {ref}."
+            f"The station metadata will be used to fill in the water_level attribute in the site.toml. The reference level will be '{ref}'."
         )
 
         return meta
@@ -2260,6 +2404,22 @@ class DatabaseBuilder:
         return gdf
 
 
+def create_database(config: Union[str, Path, ConfigModel], overwrite=False) -> None:
+    """Create a new database from a configuration file or ConfigModel.
+
+    Parameters
+    ----------
+    config : str, Path, or ConfigModel
+        The path to the configuration file (as a string or Path) or a ConfigModel instance.
+    overwrite : bool, default False
+        Whether to overwrite the existing database if it exists.
+    """
+    if isinstance(config, (str, Path)):
+        config = ConfigModel.read(config)
+
+    DatabaseBuilder(config=config).build(overwrite)
+
+
 def main():
     while True:
         config_path = Path(

flood_adapt/database_builder/templates/infographics/OSM/config_charts.toml

@@ -84,7 +84,7 @@
     [Other.Info]
         text="""Inundation depth thresholds:<br>
                 Minor: 0.25 m<br>
-                Major: 2.0 m<br>
-                Destroyed: >2.0 m"""
+                Major: 1.5 m<br>
+                Destroyed: >1.5 m"""
         image="https://openclipart.org/image/800px/302413"
         scale=0.1

flood_adapt/database_builder/templates/infographics/OSM/config_roads.toml

@@ -54,7 +54,7 @@
     [Other.Subtitle]
         font = 25
 	[Other.Y_axis_title]
-		text = "Kilometers of interruption"
+		text = "Kilometers"
     [Other.Info]
         text="""Thresholds:<br>
                 Pedestrians: 0.05 m<br>

flood_adapt/database_builder/templates/infographics/US_NSI/config_roads.toml

@@ -54,7 +54,7 @@
     [Other.Subtitle]
         font = 25
 	[Other.Y_axis_title]
-		text = "Miles of interruption"
+		text = "Miles"
     [Other.Info]
         text="""Thresholds:<br>
                 Pedestrians: 0.3 feet<br>

{flood_adapt-0.3.12.dist-info → flood_adapt-0.3.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.12
+Version: 0.3.13
 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.12.dist-info → flood_adapt-0.3.13.dist-info}/RECORD

@@ -1,9 +1,8 @@
-flood_adapt/__init__.py,sha256=TXChGK-h0gjHlNBp_CxcwBXWia75E2dUO20jRwiKdEo,875
-flood_adapt/database_builder.py,sha256=E0JPsPuq2PHhCzH0cp7kDEkRYG3XQBjlCaEoK0GGttc,436
+flood_adapt/__init__.py,sha256=_o0HF796SslLRvNHJwcrVMHtIr-z6uzMpcSX9RXInj0,819
 flood_adapt/flood_adapt.py,sha256=szovzFyApBeT-XPMZ-GNsWH-ap63ejouP7hZZjadMVU,38364
 flood_adapt/adapter/__init__.py,sha256=UuiuVz5vKDoXnvBUMJ7Yybk0pjZkYLREgTA4G1Pzj8c,258
-flood_adapt/adapter/fiat_adapter.py,sha256=QVGjVX1BOhpxVvKEsJ5p3cn5Ssj0M_GjQZXAoaiGKzY,59596
-flood_adapt/adapter/sfincs_adapter.py,sha256=n3Agc7Tx809KRvbJJ1nllwvLl9gYNVjbqWraEHCvTSw,79152
+flood_adapt/adapter/fiat_adapter.py,sha256=Lrj4avXNQrAcAw1Wmc6QJPJtRsl9DYzNnm8_fMDsHb8,60144
+flood_adapt/adapter/sfincs_adapter.py,sha256=4Je6xd_6CWTQpqqvC8kB6QdCOiv0AD4WY5eFbCgJz74,79244
 flood_adapt/adapter/sfincs_offshore.py,sha256=QWJBD1ReQuVrQn3enyQeKR-YTHTQmGxzrLOjnOJkths,7486
 flood_adapt/adapter/interface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flood_adapt/adapter/interface/hazard_adapter.py,sha256=S2NIUAMSRgxC_E-tZRJ2qIP06U1zEVdn-MnvMTrn86s,2828
@@ -16,8 +15,8 @@ flood_adapt/config/fiat.py,sha256=2w3StKeTg6-PHAz6fG8_br4QhzxWgMgbg-YQ4MVuhCk,62
 flood_adapt/config/gui.py,sha256=vCmmfApHBN7_XAK1Cu7qh0C2WURWsyC3fhL-6Ri2-Lk,10524
 flood_adapt/config/sfincs.py,sha256=oj-YtjOM58UpcoBlqlMHhEBSHP-C_yyuefxNoewv9OU,16876
 flood_adapt/config/site.py,sha256=VR90jCHWcxgoQJptNyXy7LseGjXUDRtdOjNGCddFVzI,4328
-flood_adapt/database_builder/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-flood_adapt/database_builder/database_builder.py,sha256=Ny60W5U_nVQlcBaaW73DlElBEnSP5EhmuOKmWruwjqs,91623
+flood_adapt/database_builder/__init__.py,sha256=YsI5bGcAKYmsmb5W-spp91hzsKSTRtkXBLNRxLOWml4,474
+flood_adapt/database_builder/database_builder.py,sha256=IbrahJVk8HoVZm9gdr0VdQxvnIWsPZeeJu9suQVfxyc,98880
 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
 flood_adapt/database_builder/templates/green_infra_table/green_infra_lookup_table.csv,sha256=ooQzNGQwAMSAphy5W2ZyR5boQlcwvPv9ToJx1MlZhVE,466
@@ -39,15 +38,15 @@ flood_adapt/database_builder/templates/icons/white_down_48x48.png,sha256=ZxXz4WK
 flood_adapt/database_builder/templates/icons/white_left_48x48.png,sha256=mLjrGhsMo79EyaeEK9Ykmym-knv2LHk92JTMWaAfaw0,738
 flood_adapt/database_builder/templates/icons/white_right_48x48.png,sha256=dxYJT-zTp8KXLcjRkd4toZjkPrFCjDwBbSmqPspw9Qk,753
 flood_adapt/database_builder/templates/icons/white_up_48x48.png,sha256=eahYlRiknCFlIfA26BJQl__o74cqwuKTRRZ35SgCXcY,733
-flood_adapt/database_builder/templates/infographics/OSM/config_charts.toml,sha256=m6O7MXGSmA-F82nSzD2O4EMGSrmAf8Y8S0IDOIVFmiM,2608
+flood_adapt/database_builder/templates/infographics/OSM/config_charts.toml,sha256=bHvgceR1Gb05jIv7Rk2NFNWowtFn4ztVTgF4z_OOYOk,2608
 flood_adapt/database_builder/templates/infographics/OSM/config_people.toml,sha256=k-0q5reU-0LA0QMlT5Mat8mldH9t37fMSt2pUZ0P0do,1754
 flood_adapt/database_builder/templates/infographics/OSM/config_risk_charts.toml,sha256=kwBVwsSY-D3ADuJdLxFQlSLuhxguxdNXk-dn-Pt_ud8,3804
-flood_adapt/database_builder/templates/infographics/OSM/config_roads.toml,sha256=pcdHavl1gGFY5AEU_907tmyUDtZaHDu_Uf3cEvCpnKA,1890
+flood_adapt/database_builder/templates/infographics/OSM/config_roads.toml,sha256=VFlCpP2KzGlfBPoblNdL6YlJEmccUvIlUgLaOtwxwrc,1874
 flood_adapt/database_builder/templates/infographics/OSM/styles.css,sha256=yV8U2Z1DwuyfaAL13iQHjEJcPiDHXCUzGt2REXlSKeg,762
 flood_adapt/database_builder/templates/infographics/US_NSI/config_charts.toml,sha256=7mRXeh7-pvfsHp-gFdubQXR33nqaSyzKuJVc1WILdJU,3762
 flood_adapt/database_builder/templates/infographics/US_NSI/config_people.toml,sha256=9VJ0rzIj4YZIYWATQZYmbO6KLBB-C9i7skBOvE0M3oA,1892
 flood_adapt/database_builder/templates/infographics/US_NSI/config_risk_charts.toml,sha256=kwBVwsSY-D3ADuJdLxFQlSLuhxguxdNXk-dn-Pt_ud8,3804
-flood_adapt/database_builder/templates/infographics/US_NSI/config_roads.toml,sha256=8xabCxMA9-NksDJOAQOyFLK1Y5Wwg-h0mGuF6oDBvK8,1889
+flood_adapt/database_builder/templates/infographics/US_NSI/config_roads.toml,sha256=T1QqW95D0MTeWMLDV85WdodXrIf0T7uIRZA9FU0l_is,1873
 flood_adapt/database_builder/templates/infographics/US_NSI/styles.css,sha256=yV8U2Z1DwuyfaAL13iQHjEJcPiDHXCUzGt2REXlSKeg,762
 flood_adapt/database_builder/templates/infographics/images/ambulance.png,sha256=dw5vcU_kRePrBA3Zl4_aQFz1Rc93x26y8PelY2MJ_Lo,7757
 flood_adapt/database_builder/templates/infographics/images/car.png,sha256=PFED6xR31G2P15ZGM14CyJeca7zfUlwQe2348bpPCxM,6600
@@ -133,8 +132,8 @@ flood_adapt/workflows/benefit_runner.py,sha256=VtYt0sHFymNyErpzOtuN55cKJGVm5hT2a
 flood_adapt/workflows/floodmap.py,sha256=8PMd9PBep4nkrOtavW_UXeLU15J7AZMk1QEonQxVNk0,3017
 flood_adapt/workflows/impacts_integrator.py,sha256=zPJrb3Fm6gXPCmlA3vMh-2nmIwH_DWGrJGS1BUDqHLU,2495
 flood_adapt/workflows/scenario_runner.py,sha256=o6x_p7oF0apmo6Zq-_4uBXVeL6saRJZlIX6lTCPN2Rc,2984
-flood_adapt-0.3.12.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-flood_adapt-0.3.12.dist-info/METADATA,sha256=7pl6lx3fcbpZLShAHYkWqIJgDMccSjhEyhODvG-11aA,52578
-flood_adapt-0.3.12.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-flood_adapt-0.3.12.dist-info/top_level.txt,sha256=JvzMi6cTcQPEThCfpgMEeVny3ghI1urSH0CCgVIqSzw,12
-flood_adapt-0.3.12.dist-info/RECORD,,
+flood_adapt-0.3.13.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+flood_adapt-0.3.13.dist-info/METADATA,sha256=1xQzURHQA-NHJ_1-1PHgvWzqTH7w3Fbx2oauHHG43e0,52578
+flood_adapt-0.3.13.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+flood_adapt-0.3.13.dist-info/top_level.txt,sha256=JvzMi6cTcQPEThCfpgMEeVny3ghI1urSH0CCgVIqSzw,12
+flood_adapt-0.3.13.dist-info/RECORD,,

flood_adapt/database_builder.py

@@ -1,16 +0,0 @@
-from pathlib import Path
-
-from flood_adapt.database_builder.database_builder import ConfigModel, DatabaseBuilder
-
-
-def create_database(config_path: Path) -> None:
-    """Create a new database from a configuration file or dictionary.
-
-    Parameters
-    ----------
-    config : Path
-        The path to the configuration file
-    """
-    config = ConfigModel.read(config_path)
-
-    DatabaseBuilder(config=config).build()