flood-adapt 0.3.15__py3-none-any.whl → 1.0.0rc1__py3-none-any.whl

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"

flood_adapt/config/sfincs.py

@@ -1,380 +1,23 @@
-import math
-from enum import Enum
 from pathlib import Path
-from typing import Optional, Union
+from typing import Optional
 
-import numpy as np
-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 pydantic import BaseModel, model_validator
 from tomli import load as load_toml
-from typing_extensions import Annotated
 
+from flood_adapt.config.hazard import (
+    Cstype,
+    CycloneTrackDatabaseModel,
+    DemModel,
+    FloodFrequencyModel,
+    FloodModel,
+    ObsPointModel,
+    RiverModel,
+    SCSModel,
+    SlrScenariosModel,
+    WaterlevelReferenceModel,
+)
 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
-
-
-def ensure_ascii(s: str):
-    assert s.isascii()
-    return s
-
-
-AsciiStr = Annotated[str, AfterValidator(ensure_ascii)]
-
-
-class Cstype(str, Enum):
-    """The accepted input for the variable cstype in Site."""
-
-    projected = "projected"
-    spherical = "spherical"
-
-
-class SCSModel(BaseModel):
-    """Class describing the accepted input for the variable scs.
-
-    Includes the file with the non-dimensional SCS rainfall curves in the site folder and the SCS rainfall curve type.
-
-    Attributes
-    ----------
-    file : str
-        The path to the SCS rainfall curves file.
-    type : Scstype
-        The type of the SCS rainfall curve.
-    """
-
-    file: str
-    type: Scstype
-
-
-class RiverModel(BaseModel):
-    """Model that describes the accepted input for the variable river in Site.
-
-    Attributes
-    ----------
-    name : str
-        The name of the river.
-    description : Optional[str], default=None
-        description of the river.
-    mean_discharge : us.UnitfulDischarge
-        The mean discharge of the river.
-    x_coordinate : float
-        The x coordinate of the river.
-    y_coordinate : float
-        The y coordinate of the river.
-    """
-
-    name: str
-    description: Optional[str] = None
-    mean_discharge: us.UnitfulDischarge
-    x_coordinate: float
-    y_coordinate: float
-
-
-class ObsPointModel(BaseModel):
-    """The accepted input for the variable obs_point in Site.
-
-    obs_points is used to define output locations in the hazard model, which will be plotted in the user interface.
-
-    Attributes
-    ----------
-    name : Union[int, AsciiStr]
-        The name of the observation point.
-    description : Optional[str], default=""
-        The description of the observation point.
-    ID : Optional[int], default=None
-        The ID of the observation point.
-    file : Optional[str], default=None
-        The path to the observation point data file.
-    """
-
-    name: Union[int, AsciiStr]
-    description: Optional[str] = ""
-    ID: Optional[int] = (
-        None  # if the observation station is also a tide gauge, this ID should be the same as for obs_station
-    )
-    file: Optional[str] = None  # for locally stored data
-    lat: float
-    lon: float
-
-
-class FloodFrequencyModel(BaseModel):
-    """The accepted input for the variable flood_frequency in Site."""
-
-    flooding_threshold: us.UnitfulLength
-
-
-class DemModel(BaseModel):
-    """The accepted input for the variable dem in Site.
-
-    Attributes
-    ----------
-    filename : str
-        The path to the digital elevation model file.
-    units : us.UnitTypesLength
-        The units of the digital elevation model file.
-    """
-
-    filename: str
-    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.
-
-    Attributes
-    ----------
-    name : str
-        The name of the vertical reference model.
-    height : us.UnitfulLength
-        The height of the vertical reference model relative to the main reference.
-    """
-
-    name: str
-    height: us.UnitfulLength
-
-
-class WaterlevelReferenceModel(BaseModel):
-    """The accepted input for the variable water_level in Site.
-
-    Waterlevels timeseries are calculated from user input, assumed to be relative to the `reference` vertical reference model.
-
-    For plotting in the GUI, the `reference` vertical reference model is used as the main zero-reference, all values are relative to this.
-    All other vertical reference models are plotted as dashed lines.
-
-    Attributes
-    ----------
-    reference : str
-        The name of the vertical reference model that is used as the main zero-reference.
-    datums : list[DatumModel]
-        The vertical reference models that are used to calculate the waterlevels timeseries.
-        The datums are used to calculate the waterlevels timeseries, which are relative to the `reference` vertical reference model.
-    """
-
-    reference: str
-    datums: list[DatumModel] = Field(default_factory=list)
-
-    def get_datum(self, name: str) -> DatumModel:
-        for datum in self.datums:
-            if datum.name == name:
-                return datum
-        raise ValueError(f"Could not find datum with name {name}")
-
-    @model_validator(mode="after")
-    def main_reference_should_be_in_datums_and_eq_zero(self):
-        if self.reference not in [datum.name for datum in self.datums]:
-            raise ValueError(f"Reference {self.reference} not in {self.datums}")
-        if not math.isclose(
-            self.get_datum(self.reference).height.value, 0, abs_tol=1e-6
-        ):
-            raise ValueError(f"Reference {self.reference} height is not zero")
-        return self
-
-    @model_validator(mode="after")
-    def all_datums_should_have_unique_names(self):
-        datum_names = [datum.name for datum in self.datums]
-        if len(set(datum_names)) != len(datum_names):
-            raise ValueError(f"Duplicate datum names found: {datum_names}")
-        return self
-
-
-class CycloneTrackDatabaseModel(BaseModel):
-    """The accepted input for the variable cyclone_track_database in Site.
-
-    Attributes
-    ----------
-    file : str
-        The path to the cyclone track database file.
-    """
-
-    file: str
-
-
-class SlrScenariosModel(BaseModel):
-    """The accepted input for the variable slr_scenarios.
-
-    Attributes
-    ----------
-    file : str
-        The path to the sea level rise scenarios file.
-    relative_to_year : int
-        The year to which the sea level rise scenarios are relative.
-    """
-
-    file: str
-    relative_to_year: int
-
-    def interp_slr(
-        self,
-        scenario: str,
-        year: float,
-        units: us.UnitTypesLength = us.UnitTypesLength.meters,
-    ) -> float:
-        """Interpolate SLR value and reference it to the SLR reference year from the site toml.
-
-        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
-            year to evaluate
-        units : us.UnitTypesLength, default = us.UnitTypesLength.meters
-            The units to convert the SLR value to. Default is meters.
-
-        Returns
-        -------
-        float
-            The interpolated sea level rise value in the specified units, relative to the reference year.
-
-        Raises
-        ------
-        ValueError
-            if the reference year is outside of the time range in the slr.csv file
-        ValueError
-            if the year to evaluate is outside of the time range in the slr.csv file
-        """
-        df = pd.read_csv(self.file)
-        if year > df["year"].max() or year < df["year"].min():
-            raise ValueError(
-                "The selected year is outside the range of the available SLR scenarios"
-            )
-
-        if (
-            self.relative_to_year > df["year"].max()
-            or self.relative_to_year < df["year"].min()
-        ):
-            raise ValueError(
-                f"The reference year {self.relative_to_year} is outside the range of the available SLR scenarios"
-            )
-
-        slr = np.interp(year, df["year"], df[scenario])
-        ref_slr = np.interp(self.relative_to_year, df["year"], df[scenario])
-
-        new_slr = us.UnitfulLength(
-            value=slr - ref_slr,
-            units=df["units"][0],
-        )
-        return np.round(new_slr.convert(units), decimals=2)
-
-    def plot_slr_scenarios(
-        self,
-        scenario_names: list[str],
-        output_loc: Path,
-        units: us.UnitTypesLength = us.UnitTypesLength.meters,
-    ) -> str:
-        """
-        Plot sea level rise scenarios.
-
-        Returns
-        -------
-        html_path : str
-            The path to the html plot of the sea level rise scenarios.
-        """
-        df = pd.read_csv(self.file)
-
-        ncolors = len(df.columns) - 2
-        if "units" not in df.columns:
-            raise ValueError(f"Expected column `units` in {self.file}.")
-
-        _units = df["units"].iloc[0]
-        _units = us.UnitTypesLength(_units)
-
-        if "year" not in df.columns:
-            raise ValueError(f"Expected column `year` in {self.file}.")
-
-        if (
-            self.relative_to_year > df["year"].max()
-            or self.relative_to_year < df["year"].min()
-        ):
-            raise ValueError(
-                f"The reference year {self.relative_to_year} is outside the range of the available SLR scenarios"
-            )
-
-        for scn in scenario_names:
-            ref_slr = np.interp(self.relative_to_year, df["year"], df[scn])
-            df[scn] -= ref_slr
-
-        df = df.drop(columns="units").melt(id_vars=["year"]).reset_index(drop=True)
-        # convert to units used in GUI
-        conversion_factor = us.UnitfulLength(value=1.0, units=_units).convert(units)
-        df.iloc[:, -1] = (conversion_factor * df.iloc[:, -1]).round(decimals=2)
-
-        # rename column names that will be shown in html
-        df = df.rename(
-            columns={
-                "variable": "Scenario",
-                "value": f"Sea level rise [{units.value}]",
-            }
-        )
-
-        colors = sample_colorscale(
-            "rainbow", [n / (ncolors - 1) for n in range(ncolors)]
-        )
-        fig = line(
-            df,
-            x="year",
-            y=f"Sea level rise [{units.value}]",
-            color="Scenario",
-            color_discrete_sequence=colors,
-        )
-
-        # fig.update_traces(marker={"line": {"color": "#000000", "width": 2}})
-
-        fig.update_layout(
-            autosize=False,
-            height=100 * 1.2,
-            width=280 * 1.3,
-            margin={"r": 0, "l": 0, "b": 0, "t": 0},
-            font={"size": 10, "color": "black", "family": "Arial"},
-            title_font={"size": 10, "color": "black", "family": "Arial"},
-            legend_font={"size": 10, "color": "black", "family": "Arial"},
-            legend_grouptitlefont={"size": 10, "color": "black", "family": "Arial"},
-            legend={"entrywidthmode": "fraction", "entrywidth": 0.2},
-            yaxis_title_font={"size": 10, "color": "black", "family": "Arial"},
-            xaxis_title=None,
-            xaxis_range=[self.relative_to_year, df["year"].max()],
-            legend_title=None,
-            # paper_bgcolor="#3A3A3A",
-            # plot_bgcolor="#131313",
-        )
-
-        # write html to results folder
-        output_loc.parent.mkdir(parents=True, exist_ok=True)
-        fig.write_html(output_loc)
-        return str(output_loc)
-
-
-class FloodModel(BaseModel):
-    """The accepted input for the variable overland_model and offshore_model in Site.
-
-    Attributes
-    ----------
-    name : str
-        The name of the directory in `static/templates/<directory>` that contains the template model files.
-    reference : str
-        The name of the vertical reference model that is used as the reference datum. Should be defined in water_level.datums.
-    vertical_offset : Optional[us.UnitfulLength], default = None
-        The vertical offset of the vertical reference model relative to the main reference.
-        Given that the height of the vertical reference model is often determined by external sources,
-        this vertical offset can be used to correct systematic over-/underestimation of a vertical reference model.
-    """
-
-    name: str
-    reference: str
-
-    # this used to be water_level_offset from events
-    vertical_offset: Optional[us.UnitfulLength] = None
 
 
 class SfincsConfigModel(BaseModel):

flood_adapt/database_builder/database_builder.py

@@ -28,14 +28,8 @@ from shapely import MultiLineString, MultiPolygon, Polygon
 
 from flood_adapt.adapter.fiat_adapter import _FIAT_COLUMNS
 from flood_adapt.config.fiat import (
-    AggregationModel,
-    BenefitsModel,
-    BFEModel,
-    EquityModel,
     FiatConfigModel,
     FiatModel,
-    RiskModel,
-    SVIModel,
 )
 from flood_adapt.config.gui import (
     AggregationDmgLayer,
@@ -49,21 +43,31 @@ from flood_adapt.config.gui import (
     SyntheticTideModel,
     VisualizationLayers,
 )
-from flood_adapt.config.sfincs import (
+from flood_adapt.config.hazard import (
     Cstype,
     CycloneTrackDatabaseModel,
     DatumModel,
     DemModel,
-    FloodmapType,
     FloodModel,
     ObsPointModel,
     RiverModel,
     SCSModel,
-    SfincsConfigModel,
-    SfincsModel,
     SlrScenariosModel,
     WaterlevelReferenceModel,
 )
+from flood_adapt.config.impacts import (
+    AggregationModel,
+    BenefitsModel,
+    BFEModel,
+    EquityModel,
+    FloodmapType,
+    RiskModel,
+    SVIModel,
+)
+from flood_adapt.config.sfincs import (
+    SfincsConfigModel,
+    SfincsModel,
+)
 from flood_adapt.config.site import (
     Site,
     StandardObjectModel,

flood_adapt/dbs_classes/database.py

@@ -11,7 +11,7 @@ import pandas as pd
 import xarray as xr
 from geopandas import GeoDataFrame
 
-from flood_adapt.config.sfincs import SlrScenariosModel
+from flood_adapt.config.hazard import SlrScenariosModel
 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

flood_adapt/objects/__init__.py

@@ -5,7 +5,6 @@ from flood_adapt.objects.events.events import (
     Event,
     Mode,
     Template,
-    TimeFrame,
 )
 from flood_adapt.objects.events.historical import HistoricalEvent
 from flood_adapt.objects.events.hurricane import HurricaneEvent
@@ -16,6 +15,7 @@ from flood_adapt.objects.forcing.forcing import (
     IForcing,
 )
 from flood_adapt.objects.forcing.forcing_factory import ForcingFactory
+from flood_adapt.objects.forcing.time_frame import TimeFrame
 from flood_adapt.objects.measures.measure_factory import MeasureFactory
 from flood_adapt.objects.measures.measures import (
     Buyout,
@@ -57,7 +57,6 @@ __all__ = [
     "SyntheticEvent",
     "HistoricalEvent",
     "HurricaneEvent",
-    "TimeFrame",
     "Mode",
     "Template",
     # EventSet
@@ -65,6 +64,7 @@ __all__ = [
     "SubEventModel",
     # Forcing
     "ForcingFactory",
+    "TimeFrame",
     "IForcing",
     "ForcingType",
     "ForcingSource",

flood_adapt/objects/forcing/forcing.py

@@ -8,7 +8,7 @@ from typing import Any, ClassVar, List, Type
 import tomli
 from pydantic import BaseModel, field_serializer
 
-from flood_adapt.config.sfincs import RiverModel
+from flood_adapt.config.hazard import RiverModel
 from flood_adapt.misc.log import FloodAdaptLogging
 
 

flood_adapt/objects/forcing/meteo_handler.py

@@ -1,31 +1,26 @@
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
 
 import cht_meteo
 import numpy as np
 import xarray as xr
 from cht_meteo.dataset import MeteoDataset
 
-from flood_adapt.config.config import Settings
-from flood_adapt.config.site import Site
 from flood_adapt.objects.forcing.time_frame import TimeFrame
 
 
 class MeteoHandler:
-    def __init__(self, dir: Optional[Path] = None, site: Optional[Site] = None) -> None:
-        self.dir: Path = dir or Settings().database_path / "static" / "meteo"
+    def __init__(self, dir: Path, lat: float, lon: float) -> None:
+        self.dir: Path = dir
         self.dir.mkdir(parents=True, exist_ok=True)
-        self.site: Site = site or Site.load_file(
-            Settings().database_path / "static" / "config" / "site.toml"
-        )
+
         # Create GFS dataset
         self.dataset = cht_meteo.dataset(
             name="gfs_anl_0p50",
             source="gfs_analysis_0p50",
             path=self.dir,
-            lon_range=(self.site.lon - 10, self.site.lon + 10),
-            lat_range=(self.site.lat - 10, self.site.lat + 10),
+            lon_range=(lon - 10, lon + 10),
+            lat_range=(lat - 10, lat + 10),
         )
         # quick fix for sites near the 0 degree longitude -> shift the meteo download area either east or west of the 0 degree longitude
         # TODO implement a good solution to this in cht_meteo

flood_adapt/objects/measures/measures.py

@@ -185,7 +185,7 @@ class Measure(Object):
 
         Parameters
         ----------
-        filepath : Path | str | os.PathLike
+        file_path : Path | str | os.PathLike
             Path to the file to load the measure from.
 
         Returns

flood_adapt/workflows/floodmap.py

@@ -1,7 +1,7 @@
 import os
 from pathlib import Path
 
-from flood_adapt.config.sfincs import FloodmapType
+from flood_adapt.config.impacts import FloodmapType
 from flood_adapt.misc.database_user import DatabaseUser
 from flood_adapt.misc.log import FloodAdaptLogging
 from flood_adapt.objects.events.event_set import EventSet

{flood_adapt-0.3.15.dist-info → flood_adapt-1.0.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.15
+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