flood-adapt 0.3.3__tar.gz → 0.3.5__tar.gz

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.3
+Version: 0.3.5
 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
@@ -727,6 +727,7 @@ Requires-Dist: sphinx<9.0,>=8.0; extra == "docs"
 Requires-Dist: sphinx-rtd-theme<4.0,>=3.0; extra == "docs"
 Requires-Dist: regex<2025.0,>=2024.11; extra == "docs"
 Requires-Dist: minio<8,>=7.2.15; extra == "docs"
+Requires-Dist: python-dotenv<2.0,>=1.0; extra == "docs"
 Provides-Extra: all
 Requires-Dist: flood-adapt[build,dev,docs]; extra == "all"
 

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/__init__.py

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

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/adapter/sfincs_adapter.py

@@ -176,9 +176,7 @@ class SfincsAdapter(IHazardAdapter):
             # No need to check postprocessing for risk scenarios
             return all(self.sfincs_completed(sim_path) for sim_path in sim_paths)
         else:
-            return self.sfincs_completed(
-                self._get_simulation_path(scenario)
-            ) and self.run_completed(scenario)
+            return self.sfincs_completed(self._get_simulation_path(scenario))
 
     def execute(self, path: Path, strict: bool = True) -> bool:
         """

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/config/config.py

@@ -66,7 +66,7 @@ class Settings(BaseSettings):
 
     Usage
     -----
-    from flood_adapt.config import Settings
+    from flood_adapt import Settings
 
     One of the following:
 
@@ -77,7 +77,7 @@ class Settings(BaseSettings):
         `settings = Settings.read(toml_path: Path)`
 
     3) Load settings from keyword arguments, overwriting any environment variables:
-        `settings = Settings(DATABASE_ROOT="path/to/database", DATABASE_NAME="database_name", SYSTEM_FOLDER="path/to/system_folder")`
+        `settings = Settings(DATABASE_ROOT="path/to/database", DATABASE_NAME="database_name")`
 
     Attributes
     ----------
@@ -85,19 +85,21 @@ class Settings(BaseSettings):
         The name of the database.
     database_root : Path
         The root directory of the database.
-    system_folder : Path
-        The root directory of the system folder containing the kernels.
     delete_crashed_runs : bool
         Whether to delete crashed/corrupted runs immediately after they are detected.
+    sfincs_path : Path
+        The path to the SFINCS binary.
+    fiat_path : Path
+        The path to the FIAT binary.
+    validate_allowed_forcings : bool
+        Whether to validate the forcing types and sources against the allowed forcings in the event model.
+    validate_bin_paths : bool
+        Whether to validate the existence of the paths to the SFINCS and FIAT binaries.
 
     Properties
     ----------
     database_path : Path
         The full path to the database.
-    sfincs_path : Path
-        The path to the SFINCS binary.
-    fiat_path : Path
-        The path to the FIAT binary.
 
     Raises
     ------
@@ -121,16 +123,22 @@ class Settings(BaseSettings):
 
     delete_crashed_runs: bool = Field(
         alias="DELETE_CRASHED_RUNS",  # environment variable: DELETE_CRASHED_RUNS
-        default=True,
+        default=False,
         description="Whether to delete the output of crashed/corrupted runs. Be careful when setting this to False, as it may lead to a broken database that cannot be read in anymore.",
         exclude=True,
     )
     validate_allowed_forcings: bool = Field(
         alias="VALIDATE_ALLOWED_FORCINGS",  # environment variable: VALIDATE_ALLOWED_FORCINGS
-        default=True,
+        default=False,
         description="Whether to validate the forcing types and sources against the allowed forcings in the event model.",
         exclude=True,
     )
+    validate_bin_paths: bool = Field(
+        alias="VALIDATE_BINARIES",  # environment variable: VALIDATE_BINARIES
+        default=False,
+        description="Whether to validate the existence of the paths to the SFINCS and FIAT binaries.",
+        exclude=True,
+    )
 
     sfincs_path: Path = Field(
         default=_default_exe_path("sfincs"),
@@ -154,8 +162,9 @@ class Settings(BaseSettings):
     @model_validator(mode="after")
     def validate_settings(self):
         self._validate_database_path()
-        self._validate_fiat_path()
-        self._validate_sfincs_path()
+        if self.validate_bin_paths:
+            self._validate_fiat_path()
+            self._validate_sfincs_path()
         self._update_environment_variables()
         return self
 
@@ -164,8 +173,22 @@ class Settings(BaseSettings):
         environ["DATABASE_NAME"] = self.database_name
         environ["SFINCS_BIN_PATH"] = str(self.sfincs_path)
         environ["FIAT_BIN_PATH"] = str(self.fiat_path)
-        environ["DELETE_CRASHED_RUNS"] = str(self.delete_crashed_runs)
-        environ["VALIDATE_ALLOWED_FORCINGS"] = str(self.validate_allowed_forcings)
+        environ["SFINCS_PATH"] = str(self.sfincs_path)
+        environ["FIAT_PATH"] = str(self.fiat_path)
+
+        if self.delete_crashed_runs:
+            environ["DELETE_CRASHED_RUNS"] = str(self.delete_crashed_runs)
+        else:
+            environ.pop("DELETE_CRASHED_RUNS", None)
+        if self.validate_allowed_forcings:
+            environ["VALIDATE_ALLOWED_FORCINGS"] = str(self.validate_allowed_forcings)
+        else:
+            environ.pop("VALIDATE_ALLOWED_FORCINGS", None)
+        if self.validate_bin_paths:
+            environ["VALIDATE_BINARIES"] = str(self.validate_bin_paths)
+        else:
+            environ.pop("VALIDATE_BINARIES", None)
+
         return self
 
     def _validate_database_path(self):

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/dbs_classes/dbs_benefit.py

@@ -59,27 +59,6 @@ class DbsBenefit(DbsTemplate[Benefit]):
         if output_path.exists():
             shutil.rmtree(output_path, ignore_errors=True)
 
-    def edit(self, benefit: Benefit):
-        """Edits an already existing benefit in the database.
-
-        Parameters
-        ----------
-        benefit : Benefit
-            benefit to be edited in the database
-
-        Raises
-        ------
-        ValueError
-            Raise error if name is already in use.
-        """
-        # Check if it is possible to edit the benefit.
-        super().edit(benefit)
-
-        # Delete output if edited
-        output_path = self.output_path / benefit.name
-        if output_path.exists():
-            shutil.rmtree(output_path, ignore_errors=True)
-
     def get_runner(self, name: str) -> BenefitRunner:
         return BenefitRunner(self._database, self.get(name))
 

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/dbs_classes/dbs_scenario.py

@@ -58,28 +58,6 @@ class DbsScenario(DbsTemplate[Scenario]):
         if (self.output_path / name).exists():
             shutil.rmtree(self.output_path / name, ignore_errors=False)
 
-    def edit(self, scenario: Scenario):
-        """Edits an already existing scenario in the database.
-
-        Parameters
-        ----------
-        scenario : Scenario
-            scenario to be edited in the database
-
-        Raises
-        ------
-        ValueError
-            Raise error if name is already in use.
-        """
-        # Check if it is possible to edit the scenario. This then also covers checking whether the
-        # scenario is already used in a higher level object. If this is the case, it cannot be edited.
-        super().edit(scenario)
-
-        # Delete output if edited
-        output_path = self.output_path / scenario.name
-        if output_path.exists():
-            shutil.rmtree(output_path, ignore_errors=True)
-
     def check_higher_level_usage(self, name: str) -> list[str]:
         """Check if a scenario is used in a benefit.
 

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/dbs_classes/dbs_template.py

@@ -133,30 +133,6 @@ class DbsTemplate(AbstractDatabaseElement[T_OBJECTMODEL]):
             self.input_path / object_model.name / f"{object_model.name}.toml",
         )
 
-    def edit(self, object_model: T_OBJECTMODEL):
-        """Edit an already existing object in the database.
-
-        Parameters
-        ----------
-        object_model : Object
-            object to be edited in the database
-
-        Raises
-        ------
-        ValueError
-            Raise error if name is already in use.
-        """
-        # Check if the object exists
-        if object_model.name not in self.summarize_objects()["name"]:
-            raise ValueError(
-                f"{self.display_name}: '{object_model.name}' does not exist. You cannot edit an {self.display_name.lower()} that does not exist."
-            )
-
-        # Check if it is possible to delete the object by saving with overwrite. This then
-        # also covers checking whether the object is a standard object, is already used in
-        # a higher level object. If any of these are the case, it cannot be deleted.
-        self.save(object_model, overwrite=True)
-
     def delete(self, name: str, toml_only: bool = False):
         """Delete an already existing object in the database.
 

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/dbs_classes/interface/element.py

@@ -85,22 +85,6 @@ class AbstractDatabaseElement(ABC, Generic[T_OBJECT_MODEL]):
         """
         pass
 
-    @abstractmethod
-    def edit(self, object_model: T_OBJECT_MODEL):
-        """Edits an already existing object in the database.
-
-        Parameters
-        ----------
-        object : IObject
-            object to be edited in the database
-
-        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.

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/flood_adapt.py

@@ -129,6 +129,8 @@ class FloodAdapt:
         ----------
         measure : Measure
             The measure object to save.
+        overwrite : bool, optional
+            Whether to overwrite an existing measure with the same name (default is False).
 
         Raises
         ------
@@ -137,21 +139,6 @@ class FloodAdapt:
         """
         self.database.measures.save(measure, overwrite=overwrite)
 
-    def edit_measure(self, measure: Measure) -> None:
-        """Edit a measure object in the database.
-
-        Parameters
-        ----------
-        measure : Measure
-            The measure object to edit.
-
-        Raises
-        ------
-        ValueError
-            If the measure object does not exist.
-        """
-        self.database.measures.edit(measure)
-
     def delete_measure(self, name: str) -> None:
         """Delete an measure from the database.
 
@@ -253,7 +240,7 @@ class FloodAdapt:
         """
         return Strategy(**attrs)
 
-    def save_strategy(self, strategy: Strategy) -> None:
+    def save_strategy(self, strategy: Strategy, overwrite: bool = False) -> None:
         """
         Save a strategy object to the database.
 
@@ -261,6 +248,8 @@ class FloodAdapt:
         ----------
         strategy : Strategy
             The strategy object to save.
+        overwrite : bool, optional
+            Whether to overwrite an existing strategy with the same name (default is False).
 
         Raises
         ------
@@ -268,7 +257,7 @@ class FloodAdapt:
             If the strategy object is not valid.
             If the strategy object already exists.
         """
-        self.database.strategies.save(strategy)
+        self.database.strategies.save(strategy, overwrite=overwrite)
 
     def delete_strategy(self, name: str) -> None:
         """
@@ -368,36 +357,22 @@ class FloodAdapt:
         """
         return EventSet(**attrs, sub_events=sub_events)
 
-    def save_event(self, event: Event) -> None:
+    def save_event(self, event: Event, overwrite: bool = False) -> None:
         """Save an event object to the database.
 
         Parameters
         ----------
         event : Event
             The event object to save.
+        overwrite : bool, optional
+            Whether to overwrite an existing event with the same name (default is False).
 
         Raises
         ------
         ValueError
             If the event object is not valid.
         """
-        self.database.events.save(event)
-
-    def edit_event(self, event: Event) -> None:
-        """Edit an event object in the database.
-
-        Parameters
-        ----------
-        event : Event
-            The event object to edit.
-
-        Raises
-        ------
-        ValueError
-            If the event object does not exist.
-            If the event is used in a scenario.
-        """
-        self.database.events.edit(event)
+        self.database.events.save(event, overwrite=overwrite)
 
     def delete_event(self, name: str) -> None:
         """Delete an event from the database.
@@ -519,35 +494,22 @@ class FloodAdapt:
         """
         return Projection(**attrs)
 
-    def save_projection(self, projection: Projection) -> None:
+    def save_projection(self, projection: Projection, overwrite: bool = False) -> None:
         """Save a projection object to the database.
 
         Parameters
         ----------
         projection : Projection
             The projection object to save.
+        overwrite : bool, optional
+            Whether to overwrite an existing projection with the same name (default is False).
 
         Raises
         ------
         ValueError
             If the projection object is not valid.
         """
-        self.database.projections.save(projection)
-
-    def edit_projection(self, projection: Projection) -> None:
-        """Edit a projection object in the database.
-
-        Parameters
-        ----------
-        projection : Projection
-            The projection object to edit.
-
-        Raises
-        ------
-        ValueError
-            If the projection object does not exist.
-        """
-        self.database.projections.edit(projection)
+        self.database.projections.save(projection, overwrite=overwrite)
 
     def delete_projection(self, name: str) -> None:
         """Delete a projection from the database.
@@ -676,13 +638,17 @@ class FloodAdapt:
         """
         return Scenario(**attrs)
 
-    def save_scenario(self, scenario: Scenario) -> tuple[bool, str]:
+    def save_scenario(
+        self, scenario: Scenario, overwrite: bool = False
+    ) -> tuple[bool, str]:
         """Save the scenario to the database.
 
         Parameters
         ----------
         scenario : Scenario
             The scenario to save.
+        overwrite : bool, optional
+            Whether to overwrite an existing scenario with the same name (default is False).
 
         Returns
         -------
@@ -692,26 +658,11 @@ class FloodAdapt:
             The error message if the scenario was not saved successfully.
         """
         try:
-            self.database.scenarios.save(scenario)
+            self.database.scenarios.save(scenario, overwrite=overwrite)
             return True, ""
         except Exception as e:
             return False, str(e)
 
-    def edit_scenario(self, scenario: Scenario) -> None:
-        """Edit a scenario object in the database.
-
-        Parameters
-        ----------
-        scenario : Scenario
-            The scenario object to edit.
-
-        Raises
-        ------
-        ValueError
-            If the scenario object does not exist.
-        """
-        self.database.scenarios.edit(scenario)
-
     def delete_scenario(self, name: str) -> None:
         """Delete a scenario from the database.
 
@@ -1137,35 +1088,22 @@ class FloodAdapt:
         """
         return Benefit(**attrs)
 
-    def save_benefit(self, benefit: Benefit) -> None:
+    def save_benefit(self, benefit: Benefit, overwrite: bool = False) -> None:
         """Save a benefit object to the database.
 
         Parameters
         ----------
         benefit : Benefit
             The benefit object to save.
+        overwrite : bool, optional
+            Whether to overwrite an existing benefit with the same name (default is False).
 
         Raises
         ------
         ValueError
             If the benefit object is not valid.
         """
-        self.database.benefits.save(benefit)
-
-    def edit_benefit(self, benefit: Benefit) -> None:
-        """Edit a benefit object in the database.
-
-        Parameters
-        ----------
-        benefit : Benefit
-            The benefit object to edit.
-
-        Raises
-        ------
-        ValueError
-            If the benefit object does not exist.
-        """
-        self.database.benefits.edit(benefit)
+        self.database.benefits.save(benefit, overwrite=overwrite)
 
     def delete_benefit(self, name: str) -> None:
         """Delete a benefit object from the database.

flood_adapt-0.3.5/flood_adapt/objects/forcing/__init__.py

@@ -0,0 +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",
+]

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt/workflows/scenario_runner.py

@@ -46,7 +46,7 @@ class ScenarioRunner:
                 self._database.static.get_overland_sfincs_model(),
             ]
             for hazard in hazard_models:
-                if not hazard.has_run(self._scenario):
+                if not hazard.run_completed(self._scenario):
                     hazard.run(self._scenario)
                 else:
                     self.logger.info(

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.3
+Version: 0.3.5
 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
@@ -727,6 +727,7 @@ Requires-Dist: sphinx<9.0,>=8.0; extra == "docs"
 Requires-Dist: sphinx-rtd-theme<4.0,>=3.0; extra == "docs"
 Requires-Dist: regex<2025.0,>=2024.11; extra == "docs"
 Requires-Dist: minio<8,>=7.2.15; extra == "docs"
+Requires-Dist: python-dotenv<2.0,>=1.0; extra == "docs"
 Provides-Extra: all
 Requires-Dist: flood-adapt[build,dev,docs]; extra == "all"
 

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/flood_adapt.egg-info/requires.txt

@@ -46,3 +46,4 @@ sphinx<9.0,>=8.0
 sphinx-rtd-theme<4.0,>=3.0
 regex<2025.0,>=2024.11
 minio<8,>=7.2.15
+python-dotenv<2.0,>=1.0

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/pyproject.toml

@@ -73,7 +73,8 @@ docs = [
     "sphinx             >=8.0,<9.0",
     "sphinx-rtd-theme   >=3.0,<4.0",
     "regex              >=2024.11,<2025.0",
-    "minio              >=7.2.15,<8"
+    "minio              >=7.2.15,<8",
+    "python-dotenv      >=1.0,<2.0",
 ]
 all = ["flood-adapt[build,dev,docs]"]
 
@@ -137,14 +138,21 @@ install-pre-commit = {cmd = "pre-commit install", outputs=[".git/hooks/pre-commi
 pre-commit = {cmd = "pre-commit run --all-files", depends-on=["install-pre-commit"]}
 tests = {cmd = "pytest tests"}
 
-
 [tool.pixi.feature.build.tasks]
 build-db-builder = {cmd = "python distribution/build_database_builder_executable.py"}
 
 [tool.pixi.feature.docs.tasks]
 clean-generated-docs = { cmd = "rm -rf docs/_freeze docs/_version.yml docs/api_ref docs/objects.json docs/_site" }
 clean-docs = {depends-on=["clean-generated-docs"]}
-fetch-data = { cmd = "python docs/fetch_data.py"}
-build-docs = { cmd = "quartodoc build --config docs/_quarto.yml", depends-on=[ "clean-docs", "fetch-data" ] }
+fetch-data = { cmd = "python docs/fetch_data.py" }
+build-docs = { cmd = "quartodoc build --config docs/_quarto.yml", depends-on=[ "clean-docs" ] }
 build-interlinks = { cmd = "quartodoc interlinks", depends-on=[ "clean-docs" ], cwd = "docs" }
+render-examples = { cmd = "quarto render ./docs/examples/**/*.ipynb ./docs/examples/**/*.qmd --execute" }
+open-docs = { cmd = "cmd.exe /c start docs/_site/index.html" }
 render-docs = { cmd = "quarto render ./docs --execute", depends-on=["build-docs", "build-interlinks"] }
+
+[tool.pixi.target.win-64.activation]
+scripts = [ "setup.bat" ]
+
+[tool.pixi.target.linux-64.activation]
+scripts = [ "setup.sh" ]

{flood_adapt-0.3.3 → flood_adapt-0.3.5}/tests/test_flood_adapt.py

@@ -609,7 +609,7 @@ class TestBenefits:
         benefit_dict_new["implementation_cost"] = 30000000
         benefit_dict_new["annual_maint_cost"] = 0
         benefit = test_fa.create_benefit(benefit_dict_new)
-        test_fa.edit_benefit(benefit)
+        test_fa.save_benefit(benefit, overwrite=True)
         test_fa.run_benefit("benefit_raise_properties_2080")
 
         benefit = test_fa.get_benefit("benefit_raise_properties_2080")