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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.3
+Version: 0.3.4
 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.4}/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.4"
 
 from flood_adapt import adapter, dbs_classes, objects
 from flood_adapt.config.config import Settings

{flood_adapt-0.3.3 → flood_adapt-0.3.4}/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.4/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.4}/flood_adapt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 0.3.3
+Version: 0.3.4
 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.4}/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.4}/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" ]