flood-adapt 0.3.14__tar.gz → 1.0.0rc1__tar.gz

{flood_adapt-0.3.14 → flood_adapt-1.0.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.14
+Version: 1.0.0rc1
 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
@@ -691,7 +691,7 @@ Requires-Dist: cht-observations==0.2.1
 Requires-Dist: cht-tide==0.1.1
 Requires-Dist: dask==2024.11.2
 Requires-Dist: numba_celltree==0.2.2
-Requires-Dist: fiat-toolbox==0.1.18
+Requires-Dist: fiat-toolbox==0.1.20
 Requires-Dist: fiona<2.0,>=1.0
 Requires-Dist: geojson<4.0,>=3.0
 Requires-Dist: geopandas<2.0,>=1.0

{flood_adapt-0.3.14 → flood_adapt-1.0.0rc1}/flood_adapt/__init__.py

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

{flood_adapt-0.3.14 → flood_adapt-1.0.0rc1}/flood_adapt/adapter/fiat_adapter.py

@@ -23,6 +23,7 @@ from hydromt_fiat.fiat import FiatModel
 
 from flood_adapt.adapter.interface.impact_adapter import IImpactAdapter
 from flood_adapt.config.fiat import FiatConfigModel
+from flood_adapt.config.impacts import FloodmapType
 from flood_adapt.misc.log import FloodAdaptLogging
 from flood_adapt.misc.path_builder import (
     ObjectDir,
@@ -39,7 +40,7 @@ from flood_adapt.objects.measures.measures import (
 )
 from flood_adapt.objects.projections.projections import Projection
 from flood_adapt.objects.scenarios.scenarios import Scenario
-from flood_adapt.workflows.floodmap import FloodMap, FloodmapType
+from flood_adapt.workflows.floodmap import FloodMap
 from flood_adapt.workflows.impacts_integrator import Impacts
 
 # Define naming structure for saved files

{flood_adapt-0.3.14 → flood_adapt-1.0.0rc1}/flood_adapt/adapter/sfincs_adapter.py

@@ -934,7 +934,11 @@ class SfincsAdapter(IHazardAdapter):
                 timeseries=tmp_path, magnitude=None, direction=None
             )
         elif isinstance(wind, WindMeteo):
-            ds = MeteoHandler().read(time_frame)
+            ds = MeteoHandler(
+                dir=self.database.static_path / "meteo",
+                lat=self.database.site.lat,
+                lon=self.database.site.lon,
+            ).read(time_frame)
             # data already in metric units so no conversion needed
 
             # HydroMT function: set wind forcing from grid
@@ -1018,7 +1022,11 @@ class SfincsAdapter(IHazardAdapter):
 
             self._model.setup_precip_forcing(timeseries=tmp_path)
         elif isinstance(rainfall, RainfallMeteo):
-            ds = MeteoHandler().read(time_frame)
+            ds = MeteoHandler(
+                dir=self.database.static_path / "meteo",
+                lat=self.database.site.lat,
+                lon=self.database.site.lon,
+            ).read(time_frame)
             # MeteoHandler always return metric so no conversion needed
             self._model.setup_precip_forcing_from_grid(precip=ds, aggregate=False)
         elif isinstance(rainfall, RainfallTrack):

{flood_adapt-0.3.14 → flood_adapt-1.0.0rc1}/flood_adapt/adapter/sfincs_offshore.py

@@ -138,7 +138,11 @@ class OffshoreSfincsHandler(IOffshoreSfincsHandler, DatabaseUser):
 
                     # Add pressure forcing for the offshore model (this doesnt happen normally in _add_forcing_wind() for overland models)
                     if isinstance(wind_forcing, WindMeteo):
-                        ds = MeteoHandler().read(_offshore_model._event.time)
+                        ds = MeteoHandler(
+                            dir=self.database.static_path / "meteo",
+                            lat=self.database.site.lat,
+                            lon=self.database.site.lon,
+                        ).read(_offshore_model._event.time)
                         _offshore_model._add_pressure_forcing_from_grid(ds=ds)
 
             # write sfincs model in output destination

flood_adapt-1.0.0rc1/flood_adapt/config/__init__.py

@@ -0,0 +1,92 @@
+from flood_adapt.config.config import Settings
+from flood_adapt.config.fiat import (
+    FiatConfigModel,
+    FiatModel,
+)
+from flood_adapt.config.gui import (
+    AggregationDmgLayer,
+    BenefitsLayer,
+    FloodMapLayer,
+    FootprintsDmgLayer,
+    GuiModel,
+    GuiUnitModel,
+    Layer,
+    OutputLayers,
+    PlottingModel,
+    VisualizationLayer,
+    VisualizationLayers,
+)
+from flood_adapt.config.hazard import (
+    AsciiStr,
+    Cstype,
+    CycloneTrackDatabaseModel,
+    DatumModel,
+    DemModel,
+    FloodFrequencyModel,
+    FloodModel,
+    ObsPointModel,
+    RiverModel,
+    SCSModel,
+    Scstype,
+    SlrScenariosModel,
+    WaterlevelReferenceModel,
+)
+from flood_adapt.config.impacts import (
+    AggregationModel,
+    BenefitsModel,
+    EquityModel,
+    FloodmapType,
+    NoFootprintsModel,
+    RiskModel,
+)
+from flood_adapt.config.sfincs import (
+    SfincsConfigModel,
+    SfincsModel,
+)
+from flood_adapt.config.site import Site, SiteBuilder, StandardObjectModel
+
+__all__ = [
+    # GUI
+    "GuiModel",
+    "GuiUnitModel",
+    "PlottingModel",
+    "Layer",
+    "OutputLayers",
+    "BenefitsLayer",
+    "FloodMapLayer",
+    "FootprintsDmgLayer",
+    "VisualizationLayer",
+    "VisualizationLayers",
+    "AggregationDmgLayer",
+    # FIAT
+    "FiatModel",
+    "FiatConfigModel",
+    "FloodmapType",
+    "NoFootprintsModel",
+    "RiskModel",
+    "EquityModel",
+    "BenefitsModel",
+    "AggregationModel",
+    # Config
+    "Settings",
+    # Sfincs
+    "SfincsModel",
+    "SfincsConfigModel",
+    "SCSModel",
+    "Scstype",
+    "Cstype",
+    "DemModel",
+    "DatumModel",
+    "FloodModel",
+    "RiverModel",
+    "ObsPointModel",
+    "SlrScenariosModel",
+    "FloodFrequencyModel",
+    "WaterlevelReferenceModel",
+    "CycloneTrackDatabaseModel",
+    "AsciiStr",
+    # Site
+    "Site",
+    "SiteBuilder",
+    "StandardObjectModel",
+]

{flood_adapt-0.3.14 → flood_adapt-1.0.0rc1}/flood_adapt/config/fiat.py

@@ -1,140 +1,18 @@
-from enum import Enum
 from pathlib import Path
 from typing import Optional
 
 from pydantic import BaseModel
 from tomli import load as load_toml
 
-from flood_adapt.config.sfincs import FloodmapType
-
-
-class BenefitsModel(BaseModel):
-    """The accepted input for the variable benefits in Site.
-
-    Attributes
-    ----------
-    current_year : int
-        The current year used in benefits calculations.
-    current_projection : str
-        The current projection used in benefits calculations.
-    baseline_strategy : str
-        The baseline strategy used in benefits calculations.
-    event_set : str
-        The event set used in benefits calculations.
-    """
-
-    current_year: int
-    current_projection: str
-    baseline_strategy: str
-    event_set: str
-
-
-class EquityModel(BaseModel):
-    """
-    The accepted input for the variable equity in Site.
-
-    Attributes
-    ----------
-    census_data : str
-        TODO
-    percapitaincome_label : Optional[str], default="PerCapitaIncome"
-        TODO
-    totalpopulation_label : Optional[str], default="TotalPopulation"
-        TODO
-    """
-
-    census_data: str
-    percapitaincome_label: Optional[str] = "PerCapitaIncome"
-    totalpopulation_label: Optional[str] = "TotalPopulation"
-
-
-class AggregationModel(BaseModel):
-    """The accepted input for the variable aggregation in Site.
-
-    Attributes
-    ----------
-    name : str
-        TODO
-    file : str
-        TODO
-    field_name : str
-        TODO
-    equity : Optional[EquityModel], default=None
-        TODO
-    """
-
-    name: str
-    file: str
-    field_name: str
-    equity: Optional[EquityModel] = None
-
-
-class BFEModel(BaseModel):
-    """The accepted input for the variable bfe in Site.
-
-    Attributes
-    ----------
-    geom : str
-        TODO
-    table : Optional[str], default=None
-        TODO
-    field_name : str
-        TODO
-    """
-
-    geom: str
-    table: Optional[str] = None
-    field_name: str
-
-
-class SVIModel(BaseModel):
-    """The accepted input for the variable svi in Site.
-
-    Attributes
-    ----------
-    geom : str
-        TODO
-    field_name : str
-        TODO
-    """
-
-    geom: str
-    field_name: str
-
-
-class NoFootprintsModel(BaseModel):
-    """
-    The configuration on the how to show objects with no footprints.
-
-    Attributes
-    ----------
-    shape : Optional[str], default="triangle"
-        The shape of the object with no footprints.
-    diameter_meters : Optional[float], default=10
-        The diameter of the object with no footprints in meters.
-    """
-
-    shape: Optional[str] = "triangle"
-    diameter_meters: Optional[float] = 10
-
-
-class RiskModel(BaseModel):
-    """The accepted input for the variable risk in Site.
-
-    Attributes
-    ----------
-    return_periods : list[int]
-        The return periods for the risk model.
-    """
-
-    return_periods: list = [1, 2, 5, 10, 25, 50, 100]
-
-
-class DamageType(str, Enum):
-    """The accepted input for the variable footprints_dmg_type."""
-
-    absolute = "absolute"
-    relative = "relative"
+from flood_adapt.config.impacts import (
+    AggregationModel,
+    BenefitsModel,
+    BFEModel,
+    FloodmapType,
+    NoFootprintsModel,
+    RiskModel,
+    SVIModel,
+)
 
 
 class FiatConfigModel(BaseModel):

{flood_adapt-0.3.14 → flood_adapt-1.0.0rc1}/flood_adapt/config/gui.py

@@ -7,7 +7,7 @@ import pandas as pd
 import tomli
 from pydantic import BaseModel, Field, model_validator
 
-from flood_adapt.config.fiat import DamageType
+from flood_adapt.config.impacts import DamageType
 from flood_adapt.objects.forcing import unit_system as us
 
 

flood_adapt-0.3.14/flood_adapt/config/sfincs.py → flood_adapt-1.0.0rc1/flood_adapt/config/hazard.py

@@ -8,11 +8,9 @@ import pandas as pd
 from plotly.express import line
 from plotly.express.colors import sample_colorscale
 from pydantic import AfterValidator, BaseModel, Field, model_validator
-from tomli import load as load_toml
 from typing_extensions import Annotated
 
 from flood_adapt.objects.forcing import unit_system as us
-from flood_adapt.objects.forcing.tide_gauge import TideGauge
 from flood_adapt.objects.forcing.timeseries import Scstype
 
 
@@ -120,13 +118,6 @@ class DemModel(BaseModel):
     units: us.UnitTypesLength
 
 
-class FloodmapType(str, Enum):
-    """The accepted input for the variable floodmap in Site."""
-
-    water_level = "water_level"
-    water_depth = "water_depth"
-
-
 class DatumModel(BaseModel):
     """
     The accepted input for the variable datums in WaterlevelReferenceModel.
@@ -223,8 +214,6 @@ class SlrScenariosModel(BaseModel):
 
         Parameters
         ----------
-        csv_path : Path
-            Path to the slr.csv file containing the SLR scenarios.
         scenario : str
             SLR scenario name to use from the column names in self.file
         year : float
@@ -375,107 +364,3 @@ class FloodModel(BaseModel):
 
     # this used to be water_level_offset from events
     vertical_offset: Optional[us.UnitfulLength] = None
-
-
-class SfincsConfigModel(BaseModel):
-    """The expected variables and data types of attributes of the SfincsConfig class.
-
-    Attributes
-    ----------
-    csname : str
-        The name of the CS model.
-    cstype : Cstype
-        Cstype of the CS model. must be either "projected" or "spherical".
-    version : Optional[str], default = None
-        The version of the CS model. If None, the version is not specified.
-    offshore_model : Optional[FloodModel], default = None
-        The offshore model. If None, the offshore model is not specified.
-    overland_model : FloodModel
-        The overland model. This is the main model used for the simulation.
-    floodmap_units : us.UnitTypesLength
-        The units used for the output floodmap. Sfincs always produces in metric units, this is used to convert the floodmap to the correct units.
-    save_simulation : Optional[bool], default = False
-        Whether to keep or delete the simulation files after the simulation is finished and all output files are created.
-        If True, the simulation files are kept. If False, the simulation files are deleted.
-    """
-
-    csname: str
-    cstype: Cstype
-    version: Optional[str] = None
-    offshore_model: Optional[FloodModel] = None
-    overland_model: FloodModel
-    floodmap_units: us.UnitTypesLength
-    save_simulation: Optional[bool] = False
-
-
-class SfincsModel(BaseModel):
-    """The expected variables and data types of attributes of the Sfincs class.
-
-    Attributes
-    ----------
-    config : SfincsConfigModel
-        The configuration of the Sfincs model.
-    water_level : WaterlevelReferenceModel
-        The collection of all datums and the main reference datum.
-    dem : DemModel
-        The digital elevation model.
-    flood_frequency : FloodFrequencyModel, default = FloodFrequencyModel()
-        The flood frequency model.
-    slr : SlrScenariosModel
-        Specification of the sea level rise scenarios.
-    cyclone_track_database : CycloneTrackDatabaseModel, optional, default = None
-        The cyclone track database model.
-    scs : SCSModel, optional, default = None
-        The SCS model.
-    tide_gauge : TideGauge, optional, default = None
-        The tide gauge model.
-    river : list[RiverModel], optional, default = None
-        The river model.
-    obs_point : list[ObsPointModel], optional, default = None
-        The observation point model.
-    """
-
-    config: SfincsConfigModel
-    water_level: WaterlevelReferenceModel
-    cyclone_track_database: Optional[CycloneTrackDatabaseModel] = None
-    slr_scenarios: Optional[SlrScenariosModel] = None
-    scs: Optional[SCSModel] = None  # optional for the US to use SCS rainfall curves
-    dem: DemModel
-
-    flood_frequency: FloodFrequencyModel = FloodFrequencyModel(
-        flooding_threshold=us.UnitfulLength(value=0.0, units=us.UnitTypesLength.meters)
-    )  # TODO we dont actually use this anywhere?
-
-    tide_gauge: Optional[TideGauge] = None
-    river: Optional[list[RiverModel]] = None
-    obs_point: Optional[list[ObsPointModel]] = None
-
-    @staticmethod
-    def read_toml(path: Path) -> "SfincsModel":
-        with open(path, mode="rb") as fp:
-            toml_contents = load_toml(fp)
-
-        return SfincsModel(**toml_contents)
-
-    @model_validator(mode="after")
-    def ensure_references_exist(self):
-        datum_names = [d.name for d in self.water_level.datums]
-
-        if self.config.overland_model.reference not in datum_names:
-            raise ValueError(
-                f"Could not find reference `{self.config.overland_model.reference}` in available datums: {datum_names}."
-            )
-
-        if self.config.offshore_model is not None:
-            if self.config.offshore_model.reference not in datum_names:
-                raise ValueError(
-                    f"Could not find reference `{self.config.offshore_model.reference}` in available datums: {datum_names}."
-                )
-
-        if self.tide_gauge is not None:
-            if self.tide_gauge.reference not in datum_names:
-                raise ValueError(
-                    f"Could not find reference `{self.tide_gauge.reference}` in available datums: {datum_names}."
-                )
-
-        return self

flood_adapt-1.0.0rc1/flood_adapt/config/impacts.py

@@ -0,0 +1,140 @@
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class FloodmapType(str, Enum):
+    """The accepted input for the variable floodmap in Site."""
+
+    water_level = "water_level"
+    water_depth = "water_depth"
+
+
+class BenefitsModel(BaseModel):
+    """The accepted input for the variable benefits in Site.
+
+    Attributes
+    ----------
+    current_year : int
+        The current year used in benefits calculations.
+    current_projection : str
+        The current projection used in benefits calculations.
+    baseline_strategy : str
+        The baseline strategy used in benefits calculations.
+    event_set : str
+        The event set used in benefits calculations.
+    """
+
+    current_year: int
+    current_projection: str
+    baseline_strategy: str
+    event_set: str
+
+
+class EquityModel(BaseModel):
+    """
+    The accepted input for the variable equity in Site.
+
+    Attributes
+    ----------
+    census_data : str
+        TODO
+    percapitaincome_label : Optional[str], default="PerCapitaIncome"
+        TODO
+    totalpopulation_label : Optional[str], default="TotalPopulation"
+        TODO
+    """
+
+    census_data: str
+    percapitaincome_label: Optional[str] = "PerCapitaIncome"
+    totalpopulation_label: Optional[str] = "TotalPopulation"
+
+
+class AggregationModel(BaseModel):
+    """The accepted input for the variable aggregation in Site.
+
+    Attributes
+    ----------
+    name : str
+        TODO
+    file : str
+        TODO
+    field_name : str
+        TODO
+    equity : Optional[EquityModel], default=None
+        TODO
+    """
+
+    name: str
+    file: str
+    field_name: str
+    equity: Optional[EquityModel] = None
+
+
+class BFEModel(BaseModel):
+    """The accepted input for the variable bfe in Site.
+
+    Attributes
+    ----------
+    geom : str
+        TODO
+    table : Optional[str], default=None
+        TODO
+    field_name : str
+        TODO
+    """
+
+    geom: str
+    table: Optional[str] = None
+    field_name: str
+
+
+class SVIModel(BaseModel):
+    """The accepted input for the variable svi in Site.
+
+    Attributes
+    ----------
+    geom : str
+        TODO
+    field_name : str
+        TODO
+    """
+
+    geom: str
+    field_name: str
+
+
+class NoFootprintsModel(BaseModel):
+    """
+    The configuration on the how to show objects with no footprints.
+
+    Attributes
+    ----------
+    shape : Optional[str], default="triangle"
+        The shape of the object with no footprints.
+    diameter_meters : Optional[float], default=10
+        The diameter of the object with no footprints in meters.
+    """
+
+    shape: Optional[str] = "triangle"
+    diameter_meters: Optional[float] = 10
+
+
+class RiskModel(BaseModel):
+    """The accepted input for the variable risk in Site.
+
+    Attributes
+    ----------
+    return_periods : list[int]
+        The return periods for the risk model.
+    """
+
+    return_periods: list = [1, 2, 5, 10, 25, 50, 100]
+
+
+class DamageType(str, Enum):
+    """The accepted input for the variable footprints_dmg_type."""
+
+    absolute = "absolute"
+    relative = "relative"