Merge pull request #57 from Deltares-research/feature/flet-frontend

Add Flet app package

.github/workflows/analyse.yml

@@ -17,7 +17,7 @@ jobs:
       matrix:
         python_version: ["3.12"]
         platform:
-          - { os: "ubuntu-22.04", arch: x64 }
+          - { os: "ubuntu-24.04", arch: x64 }
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
         platform:
           - { os: "macos-14", arch: arm64 }
           - { os: "macos-13", arch: x64 }
-          - { os: "ubuntu-22.04", arch: x64 }
+          - { os: "ubuntu-24.04", arch: x64 }
           - { os: "windows-2022", arch: x64 }
     steps:
       - name: Setup Linux platform

.gitignore

@@ -1,3 +1,4 @@
+.venv
 build/
 env/
 **/__pycache__/

.pre-commit-config.yaml

@@ -1,5 +1,6 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+exclude: '\.svg$'
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v5.0.0

CMakeLists.txt

@@ -7,6 +7,14 @@ project(AdaptationPathways
     HOMEPAGE_URL "https://publicwiki.deltares.nl/display/AP/Adaptation+Pathways"
 )
 
+set(AP_COPYRIGHT "2025 by TODO")
+string(JOIN ", " AP_AUTHORS
+    # TODO Add everybody, in some order (alphabet?)
+    "Kor de Jong (Geoneric, NL)"
+    "Marjolijn Haasnoot (Deltares, NL)"
+    "Willem van Deursen (Carthago Consultancy, NL)"
+)
+
 enable_testing()
 
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/environment/cmake)

documentation/CMakeLists.txt

@@ -30,7 +30,7 @@ add_custom_target(apidoc
                     --module-first
                     -d 1
                     -o ${CMAKE_CURRENT_BINARY_DIR}/api
-                    ${PROJECT_SOURCE_DIR}/source/package/adaptation_pathways
+                    ${PROJECT_SOURCE_DIR}/source/package
 )
 
 # https://www.sphinx-doc.org/en/master/man/sphinx-build.html

documentation/conf.py.in

@@ -11,15 +11,8 @@ import re
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "@CMAKE_PROJECT_NAME@"
-copyright = "2024, TODO"
-author = ", ".join(
-    [
-        # TODO Add everybody
-        "Marjolijn Haasnoot (Deltares, NL)",
-        "Willem van Deursen (Carthago Consultancy, NL)",
-        "Kor de Jong (Geoneric, NL)",
-    ]
-)
+copyright = "@AP_COPYRIGHT@"
+author = "@AP_AUTHORS@"
 version = "@CMAKE_PROJECT_VERSION_MAJOR@.@CMAKE_PROJECT_VERSION_MINOR@"
 
 # -- General configuration ---------------------------------------------------

environment/configuration/requirements-dev.txt

@@ -1,6 +1,7 @@
 build
 cairosvg
 cmake
+flet>=0.25.1
 furo
 linkchecker
 ninja

pyproject.toml

@@ -5,8 +5,8 @@ sections = "FUTURE,STDLIB,THIRDPARTY,AP,FIRSTPARTY,LOCALFOLDER"
 profile = "black"
 
 [tool.pylint]
-disable = "C0103, C0114, C0115, C0116, C0302, E0401, W0212, W0511, R0801"
 max-line-length=240
+disable = "C0103, C0114, C0115, C0116, C0302, E0401, W0212, W0511, R0801, R0902, R0903, R0913, R0914, R0904, R0917"
 extension-pkg-allow-list = [
     "matplotlib",
     "PySide6",
@@ -34,10 +34,10 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "docopt",
+    # "docopt",  # TODO flet build can't find docopt...
     "matplotlib",
     "networkx[default]",
-    "pyside6",
+    # "pyside6",
 ]
 
 [project.urls]

source/CMakeLists.txt

@@ -1,2 +1,3 @@
 add_subdirectory(package/adaptation_pathways/desktop)
+add_subdirectory(package/pathways_app)
 add_subdirectory(test)

source/package/adaptation_pathways/alias.py

@@ -10,5 +10,5 @@
 Actions = list[Action | ActionCombination]
 Sequence = tuple[Action, Action]
 Sequences = list[Sequence]
-TippingPoint = int
+TippingPoint = float
 TippingPointByAction = dict[Action, TippingPoint]

source/package/adaptation_pathways/app/__init__.py

@@ -0,0 +1,3 @@
+"""
+Contains the classes needed to communicate between the Flet app and the other parts of the codebase
+"""

source/package/adaptation_pathways/app/model/__init__.py

@@ -1,3 +1,9 @@
 """
 These models are used by the front-end app to manipulate pathways data
 """
+
+from .action import Action, ActionDependency
+from .metric import Metric
+from .pathway import Pathway
+from .pathways_project import PathwaysProject
+from .scenario import Scenario, TimeSeriesPoint

source/package/adaptation_pathways/app/model/action.py

@@ -1,7 +1,7 @@
 import dataclasses
 
-from comparisons import SequenceComparison
-from metric import Metric, MetricValue
+from .comparisons import SequenceComparison
+from .metric import MetricEffect
 
 
 @dataclasses.dataclass
@@ -10,7 +10,14 @@ class Action:
     name: str
     color: str
     icon: str
-    metric_data: dict[Metric, MetricValue | None]
+    metric_data: dict[str, MetricEffect]
+
+    def apply_effect(self, metric_id: str, value: float) -> float:
+        if metric_id not in self.metric_data:
+            return value
+
+        effect = self.metric_data[metric_id]
+        return effect.apply_to(value)
 
 
 @dataclasses.dataclass