feat(adapters): add user provided netcdf forcing

.github/workflows/docs.yml

@@ -42,7 +42,6 @@ jobs:
 
       - name: Setup env
         run: |
-                pip install tomli
                 mamba env create --file=docs/environment_docs.yml
                 mamba run -n floodadapt_docs pip install . --no-deps
                 VERSION=$(mamba run -n floodadapt_docs python -c "from flood_adapt import __version__; print(__version__)")

.gitignore

@@ -159,17 +159,22 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
-.vscode/settings.json
-.vscode/launch.json
+*.code-workspace
+
 /.idea
 /.pytest_cache
-.vscode/launch.json
+
+flood_adapt/system
+flood_adapt/system/
 /tests/test_database
 /tests/system
 system/
 
 # Pixi
 .pixi
 
+# FloodAdapt
+*.spw
+
 # auto generated docs
 docs/api_ref

.pre-commit-config.yaml

@@ -9,7 +9,8 @@ repos:
     -   id: check-toml
     -   id: check-merge-conflict
     -   id: check-added-large-files
-        exclude: '^environment/'
+        exclude: ^(environment/)$
+        args: [--maxkb=10240] # 10MB
     -   id: check-merge-conflict
     -   id: trailing-whitespace
 - repo: https://github.com/astral-sh/ruff-pre-commit
@@ -19,9 +20,9 @@ repos:
     # Run the linter.
     - id: ruff
       args: ['--fix', --exit-non-zero-on-fix]
-
     # Run the formatter.
     - id: ruff-format
+
 -   repo: https://github.com/crate-ci/typos
     rev: v1.23.6
     hooks:

.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "ms-toolsai.jupyter",
+        "github.copilot",
+        "tamasfe.even-better-toml",
+        "aaron-bond.better-comments",
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": false,
+        },
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,46 @@
+{
+    // Python settings
+    "python.analysis.typeEvaluation.strictDictionaryInference": true,
+    "python.analysis.typeEvaluation.strictListInference": true,
+    "python.analysis.typeEvaluation.strictSetInference": true,
+    "python.missingPackage.severity": "Error",
+
+    "debug.console.closeOnEnd": true,
+    "debugpy.debugJustMyCode": false,
+    "diffEditor.ignoreTrimWhitespace": false,
+    // add me when pixi "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    // add me when pixi "python.testing.pytestPath": "${workspaceFolder}/.venv/bin/pytest",
+    "python.analysis.autoSearchPaths": true,
+    "python.analysis.diagnosticSeverityOverrides": {
+        "reportMissingImports": "none"
+    },
+    // "python.analysis.extraPaths": [
+    //     "${workspaceFolder}/flood_adapt"
+    // ],
+    "python.envFile": "${workspaceFolder}/.env",
+    "python.analysis.exclude": [
+        "**/site-packages/**",
+        "**/_extensions/**",
+        "**/dist/**",
+        "**/build/**",
+        "**/__pycache__/**",
+        "**/.quarto/**",
+        "**/.pixi/**",
+        "**/.github/**",
+        "**/.teamcity/**",
+        "**/.vscode/**",
+        "**/.git/**",
+        "**/.mypy_cache/**",
+        "**/.pytest_cache/**",
+    ],
+
+    // Test settings
+    "python.testing.autoTestDiscoverOnSaveEnabled": true,
+    "python.analysis.enablePytestSupport": true,
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
+    "python.testing.promptToConfigure": true,
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+}

README.md

@@ -76,7 +76,7 @@ FloodAdapt uses a database to store, handle and organize input files, output fil
 To initialize floodadapt and configure the database, add the following lines to the top of your script / initialize function to validate and set the environment variables:
 ```python
 from pathlib import Path
-from flood_adapt.config import Settings
+from flood_adapt.misc.config import Settings
 
 # Usually ends in `Database` and can contain multiple sites
 root = Path("path/to/your/database/root")

distribution/build_database_builder_executable.py

@@ -57,8 +57,6 @@ def run_pyinstaller() -> None:
 
     command.append("--collect-all=flood_adapt")
     command.append("--recursive-copy-metadata=flood_adapt")
-    command.append("--hiddenimport=scipy.special._special_ufuncs")
-    command.append("--hiddenimport=scipy._lib.array_api_compat.numpy.fft")
     command.append("--collect-all=rasterio")
     command.append("--collect-all=pyogrio")
     command.append("--collect-all=xugrid")

docs/_quarto.yml

@@ -50,13 +50,16 @@ quartodoc:
         - name: dbs_classes.dbs_static.DbsStatic
         - name: dbs_classes.dbs_strategy.DbsStrategy
         - name: dbs_classes.dbs_template.DbsTemplate
-        - name: dbs_controller.Database
+        - name: dbs_classes.database.Database
         - name: object_model.benefit.Benefit
-        - name: object_model.direct_impacts.DirectImpacts
+        - name: adapter.direct_impacts_integrator.DirectImpacts
         - name: object_model.scenario.Scenario
-        - name: object_model.site.Site
+        - name: object_model.interface.site.Site
         - name: object_model.strategy.Strategy
-        - name: FloodAdaptLogging
+        - name: misc.log.FloodAdaptLogging
+        - name: misc.config.Settings
+        - name: misc.config.UnitSystem
+
   package: flood_adapt
 
 website:

docs/environment_docs.yml

@@ -19,6 +19,8 @@ dependencies:
 - sphinx_rtd_theme
 - sphinx-markdown-builder
 - setuptools>=61.0.0
-- tomli
 - pip:
+  - tomli
+  - tomli_w
   - quartodoc
+  - pydantic_settings

flood_adapt/__init__.py

@@ -1,9 +1,10 @@
-from pathlib import Path
-
 # has to be here at the start to avoid circular imports
-__version__ = "0.1.3"
-SRC_DIR: Path = Path(__file__).parent
+__version__ = "0.2.0"
+
+from flood_adapt.misc.config import Settings
+from flood_adapt.misc.log import FloodAdaptLogging
+from flood_adapt.object_model.io import unit_system as unit_system
 
-from flood_adapt.log import FloodAdaptLogging  # noqa: E402
+__all__ = ["Settings", "FloodAdaptLogging", "unit_system"]
 
 FloodAdaptLogging()  # Initialize logging once for the entire package