flood-adapt 0.3.9__py3-none-any.whl → 0.3.10__py3-none-any.whl

flood_adapt/objects/events/hurricane.py

@@ -1,67 +1,68 @@
-from typing import ClassVar, List
-
-from pydantic import BaseModel
-
-from flood_adapt.objects.events.events import Event, Template
-from flood_adapt.objects.forcing import unit_system as us
-from flood_adapt.objects.forcing.forcing import (
-    ForcingSource,
-    ForcingType,
-)
-from flood_adapt.objects.forcing.time_frame import TimeFrame
-
-__all__ = ["HurricaneEvent", "TranslationModel", "TimeFrame"]
-
-
-class TranslationModel(BaseModel):
-    """BaseModel describing the expected variables and data types for translation parameters of hurricane model."""
-
-    eastwest_translation: us.UnitfulLength = us.UnitfulLength(
-        value=0.0, units=us.UnitTypesLength.meters
-    )
-    northsouth_translation: us.UnitfulLength = us.UnitfulLength(
-        value=0.0, units=us.UnitTypesLength.meters
-    )
-
-
-class HurricaneEvent(Event):
-    """BaseModel describing the expected variables and data types for parameters of HurricaneEvent that extend the parent class Event.
-
-    Attributes
-    ----------
-    name : str
-        The name of the event.
-    description :
-        The description of the event. Defaults to "".
-    time : TimeFrame
-        The time frame of the event.
-    template : Template
-        The template of the event. Defaults to Template.Hurricane.
-    mode : Mode
-        The mode of the event. Defaults to Mode.single_event.
-    rainfall_multiplier : float
-        The rainfall multiplier of the event. Defaults to 1.0.
-    forcings : dict[ForcingType, list[IForcing]]
-        The forcings of the event.
-    track_name : str
-        The name of the hurricane track.
-    """
-
-    ALLOWED_FORCINGS: ClassVar[dict[ForcingType, List[ForcingSource]]] = {
-        ForcingType.RAINFALL: [
-            ForcingSource.CONSTANT,
-            ForcingSource.CSV,
-            ForcingSource.SYNTHETIC,
-            ForcingSource.TRACK,
-        ],
-        ForcingType.WIND: [ForcingSource.TRACK],
-        ForcingType.WATERLEVEL: [ForcingSource.MODEL],
-        ForcingType.DISCHARGE: [
-            ForcingSource.CSV,
-            ForcingSource.SYNTHETIC,
-            ForcingSource.CONSTANT,
-        ],
-    }
-    template: Template = Template.Hurricane
-    hurricane_translation: TranslationModel = TranslationModel()
-    track_name: str
+from typing import ClassVar, List
+
+from pydantic import BaseModel
+
+from flood_adapt.objects.events.events import Event, Template
+from flood_adapt.objects.forcing import unit_system as us
+from flood_adapt.objects.forcing.forcing import (
+    ForcingSource,
+    ForcingType,
+)
+from flood_adapt.objects.forcing.time_frame import TimeFrame
+
+__all__ = ["HurricaneEvent", "TranslationModel", "TimeFrame"]
+
+
+class TranslationModel(BaseModel):
+    """BaseModel describing the expected variables and data types for translation parameters of hurricane model."""
+
+    eastwest_translation: us.UnitfulLength = us.UnitfulLength(
+        value=0.0, units=us.UnitTypesLength.meters
+    )
+    northsouth_translation: us.UnitfulLength = us.UnitfulLength(
+        value=0.0, units=us.UnitTypesLength.meters
+    )
+
+
+class HurricaneEvent(Event):
+    """BaseModel describing the expected variables and data types for parameters of HurricaneEvent that extend the parent class Event.
+
+    Attributes
+    ----------
+    name : str
+        The name of the event.
+    description :
+        The description of the event. Defaults to "".
+    time : TimeFrame
+        The time frame of the event.
+    template : Template
+        The template of the event. Defaults to Template.Hurricane.
+    mode : Mode
+        The mode of the event. Defaults to Mode.single_event.
+    rainfall_multiplier : float
+        The rainfall multiplier of the event. Defaults to 1.0.
+    forcings : dict[ForcingType, list[IForcing]]
+        The forcings of the event.
+    track_name : str
+        The name of the hurricane track.
+    """
+
+    ALLOWED_FORCINGS: ClassVar[dict[ForcingType, List[ForcingSource]]] = {
+        ForcingType.RAINFALL: [
+            ForcingSource.CONSTANT,
+            ForcingSource.CSV,
+            ForcingSource.SYNTHETIC,
+            ForcingSource.TRACK,
+            ForcingSource.METEO,
+        ],
+        ForcingType.WIND: [ForcingSource.TRACK],
+        ForcingType.WATERLEVEL: [ForcingSource.MODEL],
+        ForcingType.DISCHARGE: [
+            ForcingSource.CSV,
+            ForcingSource.SYNTHETIC,
+            ForcingSource.CONSTANT,
+        ],
+    }
+    template: Template = Template.Hurricane
+    hurricane_translation: TranslationModel = TranslationModel()
+    track_name: str

flood_adapt/objects/events/synthetic.py

@@ -1,50 +1,46 @@
-from typing import ClassVar, List
-
-from flood_adapt.objects.events.events import (
-    Event,
-    Template,
-)
-from flood_adapt.objects.forcing.forcing import (
-    ForcingSource,
-    ForcingType,
-)
-
-
-class SyntheticEvent(Event):
-    """BaseModel describing the expected variables and data types for parameters of Synthetic that extend the parent class Event.
-
-    Attributes
-    ----------
-    time : TimeFrame
-        The time frame of the event.
-    template : Template
-        The template of the event. Defaults to Template.Synthetic.
-    mode : Mode
-        The mode of the event. Defaults to Mode.single_event.
-    rainfall_multiplier : float
-        The rainfall multiplier of the event. Defaults to 1.0.
-    forcings : dict[ForcingType, list[IForcing]]
-        The forcings of the event.
-    """
-
-    ALLOWED_FORCINGS: ClassVar[dict[ForcingType, List[ForcingSource]]] = {
-        ForcingType.RAINFALL: [
-            ForcingSource.CONSTANT,
-            ForcingSource.CSV,
-            ForcingSource.SYNTHETIC,
-        ],
-        ForcingType.WIND: [
-            ForcingSource.CSV,
-            ForcingSource.CONSTANT,
-        ],
-        ForcingType.WATERLEVEL: [
-            ForcingSource.CSV,
-            ForcingSource.SYNTHETIC,
-        ],
-        ForcingType.DISCHARGE: [
-            ForcingSource.CSV,
-            ForcingSource.SYNTHETIC,
-            ForcingSource.CONSTANT,
-        ],
-    }
-    template: Template = Template.Synthetic
+from typing import ClassVar, List
+
+from flood_adapt.objects.events.events import (
+    Event,
+    Template,
+)
+from flood_adapt.objects.forcing.forcing import (
+    ForcingSource,
+    ForcingType,
+)
+
+
+class SyntheticEvent(Event):
+    """BaseModel describing the expected variables and data types for parameters of Synthetic that extend the parent class Event.
+
+    Attributes
+    ----------
+    time : TimeFrame
+        The time frame of the event.
+    template : Template
+        The template of the event. Defaults to Template.Synthetic.
+    mode : Mode
+        The mode of the event. Defaults to Mode.single_event.
+    rainfall_multiplier : float
+        The rainfall multiplier of the event. Defaults to 1.0.
+    forcings : dict[ForcingType, list[IForcing]]
+        The forcings of the event.
+    """
+
+    ALLOWED_FORCINGS: ClassVar[dict[ForcingType, List[ForcingSource]]] = {
+        ForcingType.RAINFALL: [
+            ForcingSource.CONSTANT,
+            ForcingSource.SYNTHETIC,
+        ],
+        ForcingType.WIND: [
+            ForcingSource.CONSTANT,
+        ],
+        ForcingType.WATERLEVEL: [
+            ForcingSource.SYNTHETIC,
+        ],
+        ForcingType.DISCHARGE: [
+            ForcingSource.SYNTHETIC,
+            ForcingSource.CONSTANT,
+        ],
+    }
+    template: Template = Template.Synthetic

flood_adapt/objects/forcing/__init__.py

@@ -1,92 +1,92 @@
-from flood_adapt.objects.forcing.discharge import (
-    DischargeConstant,
-    DischargeCSV,
-    DischargeSynthetic,
-)
-from flood_adapt.objects.forcing.forcing import ForcingSource, ForcingType, IForcing
-from flood_adapt.objects.forcing.meteo_handler import MeteoHandler
-from flood_adapt.objects.forcing.rainfall import (
-    RainfallConstant,
-    RainfallCSV,
-    RainfallMeteo,
-    RainfallNetCDF,
-    RainfallSynthetic,
-    RainfallTrack,
-)
-from flood_adapt.objects.forcing.tide_gauge import TideGauge, TideGaugeSource
-from flood_adapt.objects.forcing.time_frame import TimeFrame
-from flood_adapt.objects.forcing.timeseries import (
-    BlockTimeseries,
-    CSVTimeseries,
-    GaussianTimeseries,
-    ScsTimeseries,
-    Scstype,
-    ShapeType,
-    SyntheticTimeseries,
-    TimeseriesFactory,
-    TriangleTimeseries,
-)
-from flood_adapt.objects.forcing.waterlevels import (
-    SurgeModel,
-    TideModel,
-    WaterlevelCSV,
-    WaterlevelGauged,
-    WaterlevelModel,
-    WaterlevelSynthetic,
-)
-from flood_adapt.objects.forcing.wind import (
-    WindConstant,
-    WindCSV,
-    WindMeteo,
-    WindNetCDF,
-    WindSynthetic,
-    WindTrack,
-)
-
-__all__ = [
-    # Forcing
-    "IForcing",
-    "ForcingSource",
-    "ForcingType",
-    # Timeseries
-    "ShapeType",
-    "Scstype",
-    "CSVTimeseries",
-    "TimeseriesFactory",
-    "SyntheticTimeseries",
-    "BlockTimeseries",
-    "ScsTimeseries",
-    "GaussianTimeseries",
-    "TriangleTimeseries",
-    # TimeFrame
-    "TimeFrame",
-    # Discharge
-    "DischargeConstant",
-    "DischargeCSV",
-    "DischargeSynthetic",
-    # Waterlevels
-    "WaterlevelCSV",
-    "WaterlevelGauged",
-    "WaterlevelModel",
-    "WaterlevelSynthetic",
-    "TideModel",
-    "SurgeModel",
-    "TideGauge",
-    "TideGaugeSource",
-    # Rainfall
-    "RainfallConstant",
-    "RainfallCSV",
-    "RainfallSynthetic",
-    "RainfallMeteo",
-    "RainfallNetCDF",
-    "RainfallTrack",
-    # Wind
-    "WindConstant",
-    "WindCSV",
-    "WindSynthetic",
-    "WindMeteo",
-    "WindNetCDF",
-    "WindTrack",
-    # Other
-    "MeteoHandler",
-]
+from flood_adapt.objects.forcing.discharge import (
+    DischargeConstant,
+    DischargeCSV,
+    DischargeSynthetic,
+)
+from flood_adapt.objects.forcing.forcing import ForcingSource, ForcingType, IForcing
+from flood_adapt.objects.forcing.meteo_handler import MeteoHandler
+from flood_adapt.objects.forcing.rainfall import (
+    RainfallConstant,
+    RainfallCSV,
+    RainfallMeteo,
+    RainfallNetCDF,
+    RainfallSynthetic,
+    RainfallTrack,
+)
+from flood_adapt.objects.forcing.tide_gauge import TideGauge, TideGaugeSource
+from flood_adapt.objects.forcing.time_frame import TimeFrame
+from flood_adapt.objects.forcing.timeseries import (
+    BlockTimeseries,
+    CSVTimeseries,
+    GaussianTimeseries,
+    ScsTimeseries,
+    Scstype,
+    ShapeType,
+    SyntheticTimeseries,
+    TimeseriesFactory,
+    TriangleTimeseries,
+)
+from flood_adapt.objects.forcing.waterlevels import (
+    SurgeModel,
+    TideModel,
+    WaterlevelCSV,
+    WaterlevelGauged,
+    WaterlevelModel,
+    WaterlevelSynthetic,
+)
+from flood_adapt.objects.forcing.wind import (
+    WindConstant,
+    WindCSV,
+    WindMeteo,
+    WindNetCDF,
+    WindSynthetic,
+    WindTrack,
+)
+
+__all__ = [
+    # Forcing
+    "IForcing",
+    "ForcingSource",
+    "ForcingType",
+    # Timeseries
+    "ShapeType",
+    "Scstype",
+    "CSVTimeseries",
+    "TimeseriesFactory",
+    "SyntheticTimeseries",
+    "BlockTimeseries",
+    "ScsTimeseries",
+    "GaussianTimeseries",
+    "TriangleTimeseries",
+    # TimeFrame
+    "TimeFrame",
+    # Discharge
+    "DischargeConstant",
+    "DischargeCSV",
+    "DischargeSynthetic",
+    # Waterlevels
+    "WaterlevelCSV",
+    "WaterlevelGauged",
+    "WaterlevelModel",
+    "WaterlevelSynthetic",
+    "TideModel",
+    "SurgeModel",
+    "TideGauge",
+    "TideGaugeSource",
+    # Rainfall
+    "RainfallConstant",
+    "RainfallCSV",
+    "RainfallSynthetic",
+    "RainfallMeteo",
+    "RainfallNetCDF",
+    "RainfallTrack",
+    # Wind
+    "WindConstant",
+    "WindCSV",
+    "WindSynthetic",
+    "WindMeteo",
+    "WindNetCDF",
+    "WindTrack",
+    # Other
+    "MeteoHandler",
+]

flood_adapt/objects/forcing/csv.py

@@ -1,68 +1,68 @@
-import csv
-from pathlib import Path
-
-import pandas as pd
-
-
-def read_csv(csvpath: Path) -> pd.DataFrame:
-    """Read a timeseries file and return a pd.DataFrame.
-
-    Parameters
-    ----------
-    csvpath : Path
-        Path to the CSV file.
-
-    Returns
-    -------
-    pd.DataFrame
-        Dataframe with time as index and (a) data column(s).
-    """
-    num_columns = None
-    has_header = None
-    with open(csvpath, "r") as f:
-        try:
-            # read the first 1024 bytes to determine if there is a header
-            has_header = csv.Sniffer().has_header(f.read(1024))
-        except csv.Error:
-            has_header = False
-        f.seek(0)
-        reader = csv.reader(f, delimiter=",")
-        try:
-            first_row = next(reader)
-            num_columns = len(first_row) - 1  # subtract 1 for the index column
-        except StopIteration:
-            raise ValueError(f"The CSV file is empty: {csvpath}.")
-
-    if has_header is None:
-        raise ValueError(
-            f"Could not determine if the CSV file has a header: {csvpath}."
-        )
-    if num_columns is None:
-        raise ValueError(
-            f"Could not determine the number of columns in the CSV file: {csvpath}."
-        )
-    elif num_columns < 1:
-        raise ValueError(f"CSV file must have at least one data column: {csvpath}.")
-    columns = [f"data_{i}" for i in range(num_columns)]
-    dtype = {name: float for name in columns}
-
-    df = pd.read_csv(
-        csvpath,
-        index_col=0,
-        names=columns,
-        header=0 if has_header else None,
-        parse_dates=True,
-        infer_datetime_format=True,
-        dtype=dtype,
-    )
-
-    # Any index that cannot be converted to datetime will be NaT
-    df.index = pd.to_datetime(df.index, errors="coerce")
-    df.index.names = ["time"]
-    if len(df.index) > 2:
-        df.index.freq = pd.infer_freq(df.index)
-
-    # Drop rows where the index is NaT
-    df = df[~df.index.isna()]
-
-    return df
+import csv
+from pathlib import Path
+
+import pandas as pd
+
+
+def read_csv(csvpath: Path) -> pd.DataFrame:
+    """Read a timeseries file and return a pd.DataFrame.
+
+    Parameters
+    ----------
+    csvpath : Path
+        Path to the CSV file.
+
+    Returns
+    -------
+    pd.DataFrame
+        Dataframe with time as index and (a) data column(s).
+    """
+    num_columns = None
+    has_header = None
+    with open(csvpath, "r") as f:
+        try:
+            # read the first 1024 bytes to determine if there is a header
+            has_header = csv.Sniffer().has_header(f.read(1024))
+        except csv.Error:
+            has_header = False
+        f.seek(0)
+        reader = csv.reader(f, delimiter=",")
+        try:
+            first_row = next(reader)
+            num_columns = len(first_row) - 1  # subtract 1 for the index column
+        except StopIteration:
+            raise ValueError(f"The CSV file is empty: {csvpath}.")
+
+    if has_header is None:
+        raise ValueError(
+            f"Could not determine if the CSV file has a header: {csvpath}."
+        )
+    if num_columns is None:
+        raise ValueError(
+            f"Could not determine the number of columns in the CSV file: {csvpath}."
+        )
+    elif num_columns < 1:
+        raise ValueError(f"CSV file must have at least one data column: {csvpath}.")
+    columns = [f"data_{i}" for i in range(num_columns)]
+    dtype = {name: float for name in columns}
+
+    df = pd.read_csv(
+        csvpath,
+        index_col=0,
+        names=columns,
+        header=0 if has_header else None,
+        parse_dates=True,
+        infer_datetime_format=True,
+        dtype=dtype,
+    )
+
+    # Any index that cannot be converted to datetime will be NaT
+    df.index = pd.to_datetime(df.index, errors="coerce")
+    df.index.names = ["time"]
+    if len(df.index) > 2:
+        df.index.freq = pd.infer_freq(df.index)
+
+    # Drop rows where the index is NaT
+    df = df[~df.index.isna()]
+
+    return df