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

flood_adapt/adapter/interface/hazard_adapter.py

@@ -1,70 +1,70 @@
-from abc import abstractmethod
-from typing import Any
-
-import geopandas as gpd
-
-from flood_adapt.adapter.interface.model_adapter import IAdapter
-from flood_adapt.objects.forcing.forcing import IForcing
-from flood_adapt.objects.forcing.time_frame import TimeFrame
-from flood_adapt.objects.measures.measures import Measure
-from flood_adapt.objects.projections.projections import Projection
-
-
-class IHazardAdapter(IAdapter):
-    @abstractmethod
-    def set_timing(self, time: TimeFrame):
-        """
-        Implement this to handle the timing of the event from the Event.
-
-        Access the events timing by `event.timing`, which contains the start and end time of the event, and the time step.
-        """
-        pass
-
-    @abstractmethod
-    def add_forcing(self, forcing: IForcing):
-        """
-        Implement this to handle each supported forcing type for this Hazard model.
-
-        A forcing is time series data, i.e. water levels, wind, rain, discharge, with optional time and space dimensions.
-        So this could be a single time series, or a collection of time series, or a time series associated with a spatial grid/gridpoint)
-
-        Forcings contain all information needed to implement the forcing in the hazard model. (geospatial files, parameters, etc.)
-        """
-        pass
-
-    @abstractmethod
-    def add_measure(self, measure: Measure):
-        """
-        Implement this to handle each supported measure type for this Hazard model.
-
-        A hazardmeasure is a measure that affects the hazard model, i.e. a measure that affects the water levels, wind, rain, discharge.
-        For example a measure could be a dike, a land use change, a change in the river channel, etc.
-
-        HazardMeasures contain all information needed to implement the measure in the hazard model. (geospatial files, parameters, etc.)
-
-        """
-        pass
-
-    @abstractmethod
-    def add_projection(self, projection: Projection):
-        """
-        Implement this to handle each supported projection type for this Hazard model.
-
-        A projection is a projection of the future, i.e. sea level rise, subsidence, rainfall multiplier, storm frequency increase, etc.
-        PhysicalProjections contains all information needed to implement the projection in the hazard model. (parameters, etc.)
-        """
-        pass
-
-    @abstractmethod
-    def get_model_boundary(self) -> gpd.GeoDataFrame:
-        """
-        Implement this to return the model boundary of the hazard model.
-
-        The model boundary is a geospatial file that defines the boundary of the hazard model.
-        """
-        pass
-
-    @abstractmethod
-    def get_model_grid(self) -> Any:
-        """Implement this to return the model grid of the hazard model."""
-        pass
+from abc import abstractmethod
+from typing import Any
+
+import geopandas as gpd
+
+from flood_adapt.adapter.interface.model_adapter import IAdapter
+from flood_adapt.objects.forcing.forcing import IForcing
+from flood_adapt.objects.forcing.time_frame import TimeFrame
+from flood_adapt.objects.measures.measures import Measure
+from flood_adapt.objects.projections.projections import Projection
+
+
+class IHazardAdapter(IAdapter):
+    @abstractmethod
+    def set_timing(self, time: TimeFrame):
+        """
+        Implement this to handle the timing of the event from the Event.
+
+        Access the events timing by `event.timing`, which contains the start and end time of the event, and the time step.
+        """
+        pass
+
+    @abstractmethod
+    def add_forcing(self, forcing: IForcing):
+        """
+        Implement this to handle each supported forcing type for this Hazard model.
+
+        A forcing is time series data, i.e. water levels, wind, rain, discharge, with optional time and space dimensions.
+        So this could be a single time series, or a collection of time series, or a time series associated with a spatial grid/gridpoint)
+
+        Forcings contain all information needed to implement the forcing in the hazard model. (geospatial files, parameters, etc.)
+        """
+        pass
+
+    @abstractmethod
+    def add_measure(self, measure: Measure):
+        """
+        Implement this to handle each supported measure type for this Hazard model.
+
+        A hazardmeasure is a measure that affects the hazard model, i.e. a measure that affects the water levels, wind, rain, discharge.
+        For example a measure could be a dike, a land use change, a change in the river channel, etc.
+
+        HazardMeasures contain all information needed to implement the measure in the hazard model. (geospatial files, parameters, etc.)
+
+        """
+        pass
+
+    @abstractmethod
+    def add_projection(self, projection: Projection):
+        """
+        Implement this to handle each supported projection type for this Hazard model.
+
+        A projection is a projection of the future, i.e. sea level rise, subsidence, rainfall multiplier, storm frequency increase, etc.
+        PhysicalProjections contains all information needed to implement the projection in the hazard model. (parameters, etc.)
+        """
+        pass
+
+    @abstractmethod
+    def get_model_boundary(self) -> gpd.GeoDataFrame:
+        """
+        Implement this to return the model boundary of the hazard model.
+
+        The model boundary is a geospatial file that defines the boundary of the hazard model.
+        """
+        pass
+
+    @abstractmethod
+    def get_model_grid(self) -> Any:
+        """Implement this to return the model grid of the hazard model."""
+        pass

flood_adapt/adapter/interface/impact_adapter.py

@@ -1,36 +1,36 @@
-from abc import abstractmethod
-
-from flood_adapt.adapter.interface.model_adapter import IAdapter
-from flood_adapt.objects.measures.measures import Measure
-from flood_adapt.objects.projections.projections import Projection
-from flood_adapt.workflows.floodmap import FloodMap
-
-
-class IImpactAdapter(IAdapter):
-    @abstractmethod
-    def add_measure(self, measure: Measure):
-        """
-        Implement this to handle each supported measure type for this Impact model.
-
-        An impact measure is a measure that affects the impact model, i.e. a measure that affects the elevation of buildings.
-        For example a measure could be buyouts, floodproofing etc.
-
-        ImpactMeasures contain all information needed to implement the measure in the impact model. (geospatial files, parameters, etc.)
-
-        """
-        pass
-
-    @abstractmethod
-    def add_projection(self, projection: Projection):
-        """
-        Implement this to handle each supported projection type for this Impact model.
-
-        A projection is a projection of the future, i.e. economic growth, etc.
-        SocioEconomicChange contains all information needed to implement the projection in the impact model. (parameters, etc.)
-        """
-        pass
-
-    @abstractmethod
-    def set_hazard(self, floodmap: FloodMap):
-        """Implement this to handle setting up of a hazard flood map."""
-        pass
+from abc import abstractmethod
+
+from flood_adapt.adapter.interface.model_adapter import IAdapter
+from flood_adapt.objects.measures.measures import Measure
+from flood_adapt.objects.projections.projections import Projection
+from flood_adapt.workflows.floodmap import FloodMap
+
+
+class IImpactAdapter(IAdapter):
+    @abstractmethod
+    def add_measure(self, measure: Measure):
+        """
+        Implement this to handle each supported measure type for this Impact model.
+
+        An impact measure is a measure that affects the impact model, i.e. a measure that affects the elevation of buildings.
+        For example a measure could be buyouts, floodproofing etc.
+
+        ImpactMeasures contain all information needed to implement the measure in the impact model. (geospatial files, parameters, etc.)
+
+        """
+        pass
+
+    @abstractmethod
+    def add_projection(self, projection: Projection):
+        """
+        Implement this to handle each supported projection type for this Impact model.
+
+        A projection is a projection of the future, i.e. economic growth, etc.
+        SocioEconomicChange contains all information needed to implement the projection in the impact model. (parameters, etc.)
+        """
+        pass
+
+    @abstractmethod
+    def set_hazard(self, floodmap: FloodMap):
+        """Implement this to handle setting up of a hazard flood map."""
+        pass

flood_adapt/adapter/interface/model_adapter.py

@@ -1,89 +1,89 @@
-from abc import abstractmethod
-from pathlib import Path
-
-from flood_adapt.misc.database_user import DatabaseUser
-from flood_adapt.objects.scenarios.scenarios import Scenario
-
-
-class IAdapter(DatabaseUser):
-    """Adapter interface for all models run in FloodAdapt."""
-
-    @abstractmethod
-    def has_run(self, scenario: Scenario) -> bool:
-        """Return True if the model has been run."""
-        pass
-
-    @abstractmethod
-    def __enter__(self) -> "IAdapter":
-        """Use the adapter as a context manager to handle opening and closing of the model and attached resources like logfiles.
-
-        Returns
-        -------
-            self: the adapter object
-
-        Usage
-        -----
-        >>> with Adapter(...) as model:
-        >>>     ...
-        >>>     model.get_result(...)
-        >>>     model.run(...)
-
-        Entering the with block will call adapter.__enter__() and
-        Exiting the with block (via regular execution or an error) will call adapter.__exit__()
-        """
-        pass
-
-    @abstractmethod
-    def __exit__(self, exc_type, exc_value, traceback) -> bool:
-        """Close the model and release any resources.
-
-        Usage
-        -----
-        >>> with Adapter as model:
-        >>>     ...
-        >>>     model.run()
-
-        Entering the `with` block will call adapter.__enter__()
-        Exiting the `with` block (via regular execution or an error) will call adapter.__exit__()
-
-        Returns
-        -------
-            False to propagate/reraise any exceptions that occurred in the with block
-            True to suppress any exceptions that occurred in the with block
-        """
-        pass
-
-    @abstractmethod
-    def read(self, path: Path):
-        """Read the model configuration from a path or other source."""
-        pass
-
-    @abstractmethod
-    def write(self, path_out: Path, overwrite: bool = True):
-        """Write the current model configuration to a path or other destination."""
-        pass
-
-    @abstractmethod
-    def run(self, scenario: Scenario):
-        """Perform the whole workflow (preprocess, execute and postprocess) of running the model."""
-        pass
-
-    @abstractmethod
-    def preprocess(self, scenario: Scenario):
-        """Prepare the model for execution."""
-        pass
-
-    @abstractmethod
-    def execute(self, path: Path, strict: bool = True) -> bool:
-        """Run the model kernel at the specified path.
-
-        Returns True if the model ran successfully, False otherwise.
-
-        If strict is True, raise an exception if the model fails to run.
-        """
-        pass
-
-    @abstractmethod
-    def postprocess(self, scenario: Scenario):
-        """Process the model output."""
-        pass
+from abc import abstractmethod
+from pathlib import Path
+
+from flood_adapt.misc.database_user import DatabaseUser
+from flood_adapt.objects.scenarios.scenarios import Scenario
+
+
+class IAdapter(DatabaseUser):
+    """Adapter interface for all models run in FloodAdapt."""
+
+    @abstractmethod
+    def has_run(self, scenario: Scenario) -> bool:
+        """Return True if the model has been run."""
+        pass
+
+    @abstractmethod
+    def __enter__(self) -> "IAdapter":
+        """Use the adapter as a context manager to handle opening and closing of the model and attached resources like logfiles.
+
+        Returns
+        -------
+            self: the adapter object
+
+        Usage
+        -----
+        >>> with Adapter(...) as model:
+        >>>     ...
+        >>>     model.get_result(...)
+        >>>     model.run(...)
+
+        Entering the with block will call adapter.__enter__() and
+        Exiting the with block (via regular execution or an error) will call adapter.__exit__()
+        """
+        pass
+
+    @abstractmethod
+    def __exit__(self, exc_type, exc_value, traceback) -> bool:
+        """Close the model and release any resources.
+
+        Usage
+        -----
+        >>> with Adapter as model:
+        >>>     ...
+        >>>     model.run()
+
+        Entering the `with` block will call adapter.__enter__()
+        Exiting the `with` block (via regular execution or an error) will call adapter.__exit__()
+
+        Returns
+        -------
+            False to propagate/reraise any exceptions that occurred in the with block
+            True to suppress any exceptions that occurred in the with block
+        """
+        pass
+
+    @abstractmethod
+    def read(self, path: Path):
+        """Read the model configuration from a path or other source."""
+        pass
+
+    @abstractmethod
+    def write(self, path_out: Path, overwrite: bool = True):
+        """Write the current model configuration to a path or other destination."""
+        pass
+
+    @abstractmethod
+    def run(self, scenario: Scenario):
+        """Perform the whole workflow (preprocess, execute and postprocess) of running the model."""
+        pass
+
+    @abstractmethod
+    def preprocess(self, scenario: Scenario):
+        """Prepare the model for execution."""
+        pass
+
+    @abstractmethod
+    def execute(self, path: Path, strict: bool = True) -> bool:
+        """Run the model kernel at the specified path.
+
+        Returns True if the model ran successfully, False otherwise.
+
+        If strict is True, raise an exception if the model fails to run.
+        """
+        pass
+
+    @abstractmethod
+    def postprocess(self, scenario: Scenario):
+        """Process the model output."""
+        pass

flood_adapt/adapter/interface/offshore.py

@@ -1,19 +1,19 @@
-from abc import ABC, abstractmethod
-from pathlib import Path
-
-import pandas as pd
-
-from flood_adapt.objects.scenarios.scenarios import Scenario
-
-
-class IOffshoreSfincsHandler(ABC):
-    template_path: Path
-
-    @abstractmethod
-    def get_resulting_waterlevels(self, scenario: Scenario) -> pd.DataFrame: ...
-
-    @staticmethod
-    def requires_offshore_run(scenario: Scenario) -> bool: ...
-
-    @abstractmethod
-    def run_offshore(self, scenario: Scenario): ...
+from abc import ABC, abstractmethod
+from pathlib import Path
+
+import pandas as pd
+
+from flood_adapt.objects.scenarios.scenarios import Scenario
+
+
+class IOffshoreSfincsHandler(ABC):
+    template_path: Path
+
+    @abstractmethod
+    def get_resulting_waterlevels(self, scenario: Scenario) -> pd.DataFrame: ...
+
+    @staticmethod
+    def requires_offshore_run(scenario: Scenario) -> bool: ...
+
+    @abstractmethod
+    def run_offshore(self, scenario: Scenario): ...