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

flood_adapt/dbs_classes/interface/database.py

@@ -1,139 +1,107 @@
-import os
-from abc import ABC, abstractmethod
-from pathlib import Path
-from typing import Any, Optional, Union
-
-import geopandas as gpd
-import numpy as np
-import pandas as pd
-from cht_cyclones.tropical_cyclone import TropicalCyclone
-
-from flood_adapt.config.site import Site
-from flood_adapt.dbs_classes.interface.element import AbstractDatabaseElement
-from flood_adapt.dbs_classes.interface.static import IDbsStatic
-from flood_adapt.objects.benefits.benefits import Benefit
-from flood_adapt.objects.events.events import Event
-
-
-class IDatabase(ABC):
-    base_path: Path
-    input_path: Path
-    output_path: Path
-    static_path: Path
-
-    @property
-    @abstractmethod
-    def site(self) -> Site: ...
-
-    @property
-    @abstractmethod
-    def static(self) -> IDbsStatic: ...
-
-    @property
-    @abstractmethod
-    def events(self) -> AbstractDatabaseElement: ...
-
-    @property
-    @abstractmethod
-    def scenarios(self) -> AbstractDatabaseElement: ...
-
-    @property
-    @abstractmethod
-    def strategies(self) -> AbstractDatabaseElement: ...
-
-    @property
-    @abstractmethod
-    def measures(self) -> AbstractDatabaseElement: ...
-
-    @property
-    @abstractmethod
-    def projections(self) -> AbstractDatabaseElement: ...
-
-    @property
-    @abstractmethod
-    def benefits(self) -> AbstractDatabaseElement: ...
-
-    @abstractmethod
-    def __init__(
-        self, database_path: Union[str, os.PathLike], site_name: str
-    ) -> None: ...
-
-    @abstractmethod
-    def interp_slr(self, slr_scenario: str, year: float) -> float:
-        pass
-
-    @abstractmethod
-    def plot_slr_scenarios(self) -> str:
-        pass
-
-    @abstractmethod
-    def write_to_csv(self, name: str, event: Event, df: pd.DataFrame) -> None:
-        pass
-
-    @abstractmethod
-    def write_cyc(self, event: Event, track: TropicalCyclone) -> None:
-        pass
-
-    @abstractmethod
-    def check_benefit_scenarios(self, benefit: Benefit) -> pd.DataFrame:
-        pass
-
-    @abstractmethod
-    def create_benefit_scenarios(self, benefit: Benefit) -> None:
-        pass
-
-    @abstractmethod
-    def run_benefit(self, benefit_name: Union[str, list[str]]) -> None:
-        pass
-
-    @abstractmethod
-    def get_outputs(self) -> dict[str, Any]:
-        pass
-
-    @abstractmethod
-    def get_topobathy_path(self) -> str:
-        pass
-
-    @abstractmethod
-    def get_index_path(self) -> str:
-        pass
-
-    @abstractmethod
-    def get_depth_conversion(self) -> float:
-        pass
-
-    @abstractmethod
-    def get_max_water_level(
-        self, scenario_name: str, return_period: Optional[int] = None
-    ) -> np.ndarray:
-        pass
-
-    @abstractmethod
-    def get_building_footprints(self, scenario_name: str) -> gpd.GeoDataFrame:
-        pass
-
-    @abstractmethod
-    def get_roads(self, scenario_name: str) -> gpd.GeoDataFrame:
-        pass
-
-    @abstractmethod
-    def get_aggregation(self, scenario_name: str) -> dict[str, gpd.GeoDataFrame]:
-        pass
-
-    @abstractmethod
-    def get_aggregation_benefits(
-        self, benefit_name: str
-    ) -> dict[str, gpd.GeoDataFrame]:
-        pass
-
-    @abstractmethod
-    def get_object_list(self, object_type: str) -> dict[str, Any]:
-        pass
-
-    @abstractmethod
-    def has_run_hazard(self, scenario_name: str) -> None:
-        pass
-
-    @abstractmethod
-    def cleanup(self) -> None:
-        pass
+import os
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Any, Optional, Union
+
+import geopandas as gpd
+import numpy as np
+
+from flood_adapt.config.site import Site
+from flood_adapt.dbs_classes.interface.element import AbstractDatabaseElement
+from flood_adapt.dbs_classes.interface.static import IDbsStatic
+
+
+class IDatabase(ABC):
+    base_path: Path
+    input_path: Path
+    output_path: Path
+    static_path: Path
+
+    @property
+    @abstractmethod
+    def site(self) -> Site: ...
+
+    @property
+    @abstractmethod
+    def static(self) -> IDbsStatic: ...
+
+    @property
+    @abstractmethod
+    def events(self) -> AbstractDatabaseElement: ...
+
+    @property
+    @abstractmethod
+    def scenarios(self) -> AbstractDatabaseElement: ...
+
+    @property
+    @abstractmethod
+    def strategies(self) -> AbstractDatabaseElement: ...
+
+    @property
+    @abstractmethod
+    def measures(self) -> AbstractDatabaseElement: ...
+
+    @property
+    @abstractmethod
+    def projections(self) -> AbstractDatabaseElement: ...
+
+    @property
+    @abstractmethod
+    def benefits(self) -> AbstractDatabaseElement: ...
+
+    @abstractmethod
+    def __init__(
+        self, database_path: Union[str, os.PathLike], site_name: str
+    ) -> None: ...
+
+    @abstractmethod
+    def get_outputs(self) -> dict[str, Any]:
+        pass
+
+    @abstractmethod
+    def get_topobathy_path(self) -> str:
+        pass
+
+    @abstractmethod
+    def get_index_path(self) -> str:
+        pass
+
+    @abstractmethod
+    def get_depth_conversion(self) -> float:
+        pass
+
+    @abstractmethod
+    def get_max_water_level(
+        self, scenario_name: str, return_period: Optional[int] = None
+    ) -> np.ndarray:
+        pass
+
+    @abstractmethod
+    def get_building_footprints(self, scenario_name: str) -> gpd.GeoDataFrame:
+        pass
+
+    @abstractmethod
+    def get_roads(self, scenario_name: str) -> gpd.GeoDataFrame:
+        pass
+
+    @abstractmethod
+    def get_aggregation(self, scenario_name: str) -> dict[str, gpd.GeoDataFrame]:
+        pass
+
+    @abstractmethod
+    def get_aggregation_benefits(
+        self, benefit_name: str
+    ) -> dict[str, gpd.GeoDataFrame]:
+        pass
+
+    @abstractmethod
+    def get_object_list(self, object_type: str) -> dict[str, Any]:
+        pass
+
+    @abstractmethod
+    def has_run_hazard(self, scenario_name: str) -> None:
+        pass
+
+    @abstractmethod
+    def cleanup(self) -> None:
+        pass

flood_adapt/dbs_classes/interface/element.py

@@ -1,121 +1,121 @@
-from abc import ABC, abstractmethod
-from pathlib import Path
-from typing import Any, Generic, TypeVar
-
-from flood_adapt.objects.object_model import Object
-
-T_OBJECT_MODEL = TypeVar("T_OBJECT_MODEL", bound=Object)
-
-
-class AbstractDatabaseElement(ABC, Generic[T_OBJECT_MODEL]):
-    input_path: Path
-    output_path: Path
-
-    @abstractmethod
-    def __init__(self):
-        """Abstract class for database elements."""
-        pass
-
-    @abstractmethod
-    def get(self, name: str) -> T_OBJECT_MODEL:
-        """Return the object of the type of the database with the given name.
-
-        Parameters
-        ----------
-        name : str
-            name of the object to be returned
-
-        Returns
-        -------
-        IObject
-            object of the type of the specified object model
-        """
-        pass
-
-    @abstractmethod
-    def summarize_objects(self) -> dict[str, list[Any]]:
-        """Return a dictionary with info on the objects that currently exist in the database.
-
-        Returns
-        -------
-        dict[str, Any]
-            Includes 'name', 'description', 'path' and 'last_modification_date' info, as well as the objects themselves
-        """
-        pass
-
-    @abstractmethod
-    def copy(self, old_name: str, new_name: str, new_description: str):
-        """Copy (duplicate) an existing object, and give it a new name.
-
-        Parameters
-        ----------
-        old_name : str
-            name of the existing measure
-        new_name : str
-            name of the new measure
-        new_description : str
-            description of the new measure
-        """
-        pass
-
-    @abstractmethod
-    def save(
-        self,
-        object_model: T_OBJECT_MODEL,
-        overwrite: bool = False,
-    ):
-        """Save an object in the database.
-
-        This only saves the toml file. If the object also contains a geojson file, this should be saved separately.
-
-        Parameters
-        ----------
-        object_model : Object
-            object to be saved in the database
-        overwrite : bool, optional
-            whether to overwrite the object if it already exists in the
-            database, by default False
-        toml_only : bool, optional
-            whether to only save the toml file or all associated data. By default, save everything
-
-        Raises
-        ------
-        ValueError
-            Raise error if name is already in use.
-        """
-        pass
-
-    @abstractmethod
-    def delete(self, name: str, toml_only: bool = False):
-        """Delete an already existing object in the database.
-
-        Parameters
-        ----------
-        name : str
-            name of the object to be deleted
-        toml_only : bool, optional
-            whether to only delete the toml file or the entire folder. If the folder is empty after deleting the toml,
-            it will always be deleted. By default False
-
-        Raises
-        ------
-        ValueError
-            Raise error if object to be deleted is already in use.
-        """
-        pass
-
-    @abstractmethod
-    def check_higher_level_usage(self, name: str) -> list[str]:
-        """Check if an object is used in a higher level object.
-
-        Parameters
-        ----------
-        name : str
-            name of the object to be checked
-
-        Returns
-        -------
-        list[str]
-            list of higher level objects that use the object
-        """
-        pass
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Any, Generic, TypeVar
+
+from flood_adapt.objects.object_model import Object
+
+T_OBJECT_MODEL = TypeVar("T_OBJECT_MODEL", bound=Object)
+
+
+class AbstractDatabaseElement(ABC, Generic[T_OBJECT_MODEL]):
+    input_path: Path
+    output_path: Path
+
+    @abstractmethod
+    def __init__(self):
+        """Abstract class for database elements."""
+        pass
+
+    @abstractmethod
+    def get(self, name: str) -> T_OBJECT_MODEL:
+        """Return the object of the type of the database with the given name.
+
+        Parameters
+        ----------
+        name : str
+            name of the object to be returned
+
+        Returns
+        -------
+        IObject
+            object of the type of the specified object model
+        """
+        pass
+
+    @abstractmethod
+    def summarize_objects(self) -> dict[str, list[Any]]:
+        """Return a dictionary with info on the objects that currently exist in the database.
+
+        Returns
+        -------
+        dict[str, Any]
+            Includes 'name', 'description', 'path' and 'last_modification_date' info, as well as the objects themselves
+        """
+        pass
+
+    @abstractmethod
+    def copy(self, old_name: str, new_name: str, new_description: str):
+        """Copy (duplicate) an existing object, and give it a new name.
+
+        Parameters
+        ----------
+        old_name : str
+            name of the existing measure
+        new_name : str
+            name of the new measure
+        new_description : str
+            description of the new measure
+        """
+        pass
+
+    @abstractmethod
+    def save(
+        self,
+        object_model: T_OBJECT_MODEL,
+        overwrite: bool = False,
+    ):
+        """Save an object in the database.
+
+        This only saves the toml file. If the object also contains a geojson file, this should be saved separately.
+
+        Parameters
+        ----------
+        object_model : Object
+            object to be saved in the database
+        overwrite : bool, optional
+            whether to overwrite the object if it already exists in the
+            database, by default False
+        toml_only : bool, optional
+            whether to only save the toml file or all associated data. By default, save everything
+
+        Raises
+        ------
+        ValueError
+            Raise error if name is already in use.
+        """
+        pass
+
+    @abstractmethod
+    def delete(self, name: str, toml_only: bool = False):
+        """Delete an already existing object in the database.
+
+        Parameters
+        ----------
+        name : str
+            name of the object to be deleted
+        toml_only : bool, optional
+            whether to only delete the toml file or the entire folder. If the folder is empty after deleting the toml,
+            it will always be deleted. By default False
+
+        Raises
+        ------
+        ValueError
+            Raise error if object to be deleted is already in use.
+        """
+        pass
+
+    @abstractmethod
+    def check_higher_level_usage(self, name: str) -> list[str]:
+        """Check if an object is used in a higher level object.
+
+        Parameters
+        ----------
+        name : str
+            name of the object to be checked
+
+        Returns
+        -------
+        list[str]
+            list of higher level objects that use the object
+        """
+        pass

flood_adapt/dbs_classes/interface/static.py

@@ -1,47 +1,47 @@
-from abc import ABC, abstractmethod
-from pathlib import Path
-from typing import Union
-
-import geopandas as gpd
-import pandas as pd
-from cht_cyclones.cyclone_track_database import CycloneTrackDatabase
-
-from flood_adapt.adapter.sfincs_adapter import SfincsAdapter
-
-
-class IDbsStatic(ABC):
-    @abstractmethod
-    def get_aggregation_areas(self) -> dict: ...
-
-    @abstractmethod
-    def get_model_boundary(self) -> gpd.GeoDataFrame: ...
-
-    @abstractmethod
-    def get_model_grid(self): ...
-
-    @abstractmethod
-    def get_obs_points(self) -> gpd.GeoDataFrame: ...
-
-    @abstractmethod
-    def get_static_map(self, path: Union[str, Path]) -> gpd.GeoDataFrame: ...
-
-    @abstractmethod
-    def get_slr_scn_names(self) -> list: ...
-
-    @abstractmethod
-    def get_green_infra_table(self, measure_type: str) -> pd.DataFrame: ...
-
-    @abstractmethod
-    def get_buildings(self) -> gpd.GeoDataFrame: ...
-
-    @abstractmethod
-    def get_property_types(self) -> list: ...
-
-    @abstractmethod
-    def get_overland_sfincs_model(self) -> SfincsAdapter: ...
-
-    @abstractmethod
-    def get_offshore_sfincs_model(self) -> SfincsAdapter: ...
-
-    @abstractmethod
-    def get_cyclone_track_database(self) -> CycloneTrackDatabase: ...
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Union
+
+import geopandas as gpd
+import pandas as pd
+from cht_cyclones.cyclone_track_database import CycloneTrackDatabase
+
+from flood_adapt.adapter.sfincs_adapter import SfincsAdapter
+
+
+class IDbsStatic(ABC):
+    @abstractmethod
+    def get_aggregation_areas(self) -> dict: ...
+
+    @abstractmethod
+    def get_model_boundary(self) -> gpd.GeoDataFrame: ...
+
+    @abstractmethod
+    def get_model_grid(self): ...
+
+    @abstractmethod
+    def get_obs_points(self) -> gpd.GeoDataFrame: ...
+
+    @abstractmethod
+    def get_static_map(self, path: Union[str, Path]) -> gpd.GeoDataFrame: ...
+
+    @abstractmethod
+    def get_slr_scn_names(self) -> list: ...
+
+    @abstractmethod
+    def get_green_infra_table(self, measure_type: str) -> pd.DataFrame: ...
+
+    @abstractmethod
+    def get_buildings(self) -> gpd.GeoDataFrame: ...
+
+    @abstractmethod
+    def get_property_types(self) -> list: ...
+
+    @abstractmethod
+    def get_overland_sfincs_model(self) -> SfincsAdapter: ...
+
+    @abstractmethod
+    def get_offshore_sfincs_model(self) -> SfincsAdapter: ...
+
+    @abstractmethod
+    def get_cyclone_track_database(self) -> CycloneTrackDatabase: ...