Merge branch 'scenario-dev-pa' into scenarios.

src/Model/GeoTIFF/GeoTIFF.py

@@ -0,0 +1,368 @@
+# GeoTIFF.py -- Pamhyr
+# Copyright (C) 2024-2025  INRAE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+import os
+import struct
+import logging
+
+from functools import reduce
+
+from tools import trace, timer
+
+from Model.Tools.PamhyrDB import SQLSubModel
+from Model.Except import NotImplementedMethodeError
+from Model.Scenario import Scenario
+
+try:
+    import rasterio
+    import rasterio.control
+    import rasterio.crs
+    import rasterio.sample
+    import rasterio.vrt
+    import rasterio._features
+
+    from rasterio.io import MemoryFile
+    _rasterio_loaded = True
+except Exception as e:
+    print(f"Module 'rasterio' is not available: {e}")
+    _rasterio_loaded = False
+
+logger = logging.getLogger()
+
+
+class GeoTIFF(SQLSubModel):
+    _sub_classes = []
+
+    def __init__(self, id: int = -1, enabled=True,
+                 name="", description="",
+                 path="", coordinates=None,
+                 status=None, owner_scenario=-1):
+        super(GeoTIFF, self).__init__(
+            id=id, status=status,
+            owner_scenario=owner_scenario
+        )
+
+        self._enabled = enabled
+        self._name = f"GeoTIFF #{self._pamhyr_id}" if name == "" else name
+        self._description = description
+
+        self._file_bytes = b''
+        if coordinates is None:
+            self._coordinates = {
+                "bottom": 0.0,
+                "top": 0.0,
+                "left": 0.0,
+                "right": 0.0,
+            }
+        else:
+            self._coordinates = coordinates
+        self._file_name = ""
+
+        if path != "":
+            self.read_file(path)
+
+        self._memfile = None
+
+    def __getitem__(self, key):
+        value = None
+
+        if key == "enabled":
+            value = self._enabled
+        elif key == "name":
+            value = self.name
+        elif key == "description":
+            value = self.description
+        elif key == "file_name":
+            value = self.file_name
+        elif key == "coordinates":
+            value = self.coordinates
+        elif key == "coordinates_bottom":
+            value = self.coordinates["bottom"]
+        elif key == "coordinates_top":
+            value = self.coordinates["top"]
+        elif key == "coordinates_left":
+            value = self.coordinates["left"]
+        elif key == "coordinates_right":
+            value = self.coordinates["right"]
+        elif key == "memfile":
+            value = self.memfile
+
+        return value
+
+    def __setitem__(self, key, value):
+        if key == "enabled":
+            self.enabled = value
+        elif key == "name":
+            self.name = value
+        elif key == "description":
+            self.description = value
+        elif key == "file_name":
+            if self._file_name != value:
+                self.read_file(value)
+        elif key == "coordinates":
+            self.coordinates = value
+        elif key == "coordinates_bottom" or key == "bottom":
+            self.coordinates["bottom"] = value
+        elif key == "coordinates_top" or key == "top":
+            self.coordinates["top"] = value
+        elif key == "coordinates_left" or key == "left":
+            self.coordinates["left"] = value
+        elif key == "coordinates_right" or key == "right":
+            self.coordinates["right"] = value
+
+        self.modified()
+
+    @property
+    def enabled(self):
+        return self._enabled
+
+    @enabled.setter
+    def enabled(self, enabled):
+        self._enabled = enabled
+        self.modified()
+
+    def is_enabled(self):
+        return self._enabled
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        self._name = name
+        self.modified()
+
+    @property
+    def description(self):
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        self._description = description
+        self.modified()
+
+    @property
+    def file_name(self):
+        return self._file_name
+
+    @file_name.setter
+    def file_name(self, file_name):
+        self._file_name = file_name
+        self.modified()
+
+    @property
+    def coordinates(self):
+        return self._coordinates
+
+    @coordinates.setter
+    def coordinates(self, coordinates):
+        self._coordinates = coordinates
+        self.modified()
+
+    @property
+    def coord_bottom(self):
+        if self._coordinates is None:
+            return 0.0
+
+        return self._coordinates["bottom"]
+
+    @property
+    def coord_top(self):
+        if self._coordinates is None:
+            return 0.0
+
+        return self._coordinates["top"]
+
+    @property
+    def coord_left(self):
+        if self._coordinates is None:
+            return 0.0
+
+        return self._coordinates["left"]
+
+    @property
+    def coord_right(self):
+        if self._coordinates is None:
+            return 0.0
+
+        return self._coordinates["right"]
+
+    @property
+    def memfile(self):
+        if not _rasterio_loaded:
+            return None
+
+        if self._file_bytes == b'':
+            return None
+
+        if self._memfile is None:
+            self._memfile = MemoryFile()
+            self._memfile.write(self._file_bytes)
+
+        return self._memfile
+
+    def read_file(self, path):
+        logger.debug(f"Read GeoTIFF file at : '{path}'")
+
+        self._file_name = path
+        self._file_bytes = b''
+        self._memfile = None
+
+        nbytes = 0
+
+        with open(path, "rb") as f:
+            while True:
+                data = f.read(4096)
+                if not data:
+                    break
+
+                nbytes += len(data)
+                self._file_bytes += data
+
+        logger.debug(f"Read GeoTIFF: {nbytes} bytes readed")
+
+    def write_file(self, path):
+        with open(path, "w+b") as f:
+            f.write(self._file_bytes)
+
+    @classmethod
+    def _db_create(cls, execute, ext=""):
+        execute(f"""
+          CREATE TABLE geotiff{ext} (
+            {cls.create_db_add_pamhyr_id()},
+            enabled BOOLEAN NOT NULL,
+            deleted BOOLEAN NOT NULL DEFAULT FALSE,
+            name TEXT NOT NULL,
+            description TEXT NOT NULL,
+            file_name TEXT NOT NULL,
+            file_bytes BLOB NOT NULL,
+            coordinates_bottom REAL NOT NULL,
+            coordinates_top REAL NOT NULL,
+            coordinates_left REAL NOT NULL,
+            coordinates_right REAL NOT NULL,
+            {Scenario.create_db_add_scenario()},
+            {Scenario.create_db_add_scenario_fk()},
+            PRIMARY KEY(pamhyr_id, scenario)
+          )
+        """)
+
+        return cls._create_submodel(execute)
+
+    @classmethod
+    def _db_update(cls, execute, version, data=None):
+        major, minor, release = version.strip().split(".")
+
+        if major == "0" and int(minor) < 2:
+            cls._db_create(execute)
+
+        if major == "0" and int(minor) == 2:
+            if int(release) < 3:
+                cls._db_create(execute)
+
+        return True
+
+    @classmethod
+    def _db_load(cls, execute, data=None):
+        new = []
+        scenario = data["scenario"]
+        loaded = data['loaded_pid']
+
+        if scenario is None:
+            return new
+
+        table = execute(
+            "SELECT pamhyr_id, enabled, deleted, " +
+            "name, description, file_name, file_bytes, " +
+            "coordinates_bottom, coordinates_top, " +
+            "coordinates_left, coordinates_right, " +
+            "scenario " +
+            "FROM geotiff " +
+            f"WHERE scenario = {scenario.id} " +
+            f"AND pamhyr_id NOT IN ({', '.join(map(str, loaded))})"
+        )
+
+        if table is not None:
+            for row in table:
+                it = iter(row)
+
+                id = next(it)
+                enabled = (next(it) == 1)
+                deleted = (next(it) == 1)
+                name = next(it)
+                description = next(it)
+                file_name = next(it)
+                file_bytes = next(it)
+                coordinates_bottom = next(it)
+                coordinates_top = next(it)
+                coordinates_left = next(it)
+                coordinates_right = next(it)
+                owner_scenario = next(it)
+
+                f = cls(
+                    id=id, enabled=enabled, name=name,
+                    description=description, coordinates={
+                        "bottom": coordinates_bottom,
+                        "top": coordinates_top,
+                        "left": coordinates_left,
+                        "right": coordinates_right,
+                    },
+                    status=data['status'],
+                    owner_scenario=owner_scenario
+                )
+                if deleted:
+                    f.set_as_deleted()
+
+                f._file_bytes = file_bytes
+
+                loaded.add(id)
+                new.append(f)
+
+        data["scenario"] = scenario.parent
+        new += cls._db_load(execute, data)
+        data["scenario"] = scenario
+
+        return new
+
+    def _db_save(self, execute, data=None):
+        if not self.must_be_saved():
+            return True
+
+        execute(
+            "INSERT INTO geotiff (" +
+            "pamhyr_id, enabled, deleted, " +
+            "name, description, file_name, file_bytes, " +
+            "coordinates_bottom, coordinates_top, " +
+            "coordinates_left, coordinates_right, " +
+            "scenario) " +
+            "VALUES (?,?,?,?,?,?,?,?,?,?,?,?)",
+            self._pamhyr_id,
+            self._enabled,
+            self.is_deleted(),
+            self.name,
+            self.description,
+            self.file_name,
+            self._file_bytes,
+            self.coordinates['bottom'],
+            self.coordinates['top'],
+            self.coordinates['left'],
+            self.coordinates['right'],
+            self._status.scenario_id,
+        )
+
+        return True

src/Model/GeoTIFF/GeoTIFFList.py

@@ -0,0 +1,59 @@
+# GeoTIFFList.py -- Pamhyr
+# Copyright (C) 2024-2025  INRAE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+from tools import trace, timer
+
+from Model.Except import NotImplementedMethodeError
+from Model.Tools.PamhyrListExt import PamhyrModelList
+from Model.GeoTIFF.GeoTIFF import GeoTIFF
+
+
+class GeoTIFFList(PamhyrModelList):
+    _sub_classes = [GeoTIFF]
+
+    @classmethod
+    def _db_load(cls, execute, data=None):
+        new = cls(status=data["status"])
+
+        new._lst = GeoTIFF._db_load(execute, data)
+
+        return new
+
+    def _db_save(self, execute, data=None):
+        ok = True
+
+        # Delete previous data
+        execute(
+            "DELETE FROM geotiff " +
+            f"WHERE scenario = {self._status.scenario_id}"
+        )
+
+        for gt in self._lst:
+            ok &= gt._db_save(execute, data)
+
+        return ok
+
+    @property
+    def files(self):
+        return self.lst
+
+    def new(self, index):
+        n = GeoTIFF(status=self._status)
+        self.insert(index, n)
+        self._status.modified()
+        return n

src/Model/Reservoir/Reservoir.py

@@ -310,7 +310,7 @@ class Reservoir(SQLSubModel):
                 new_reservoir.set_as_deleted()
 
             new_reservoir._node = None
-            if node_id != -1:
+            if node_id != -1 and node_id is not None:
                 new_reservoir._node = next(
                     filter(
                         lambda n: n.id == node_id, data["nodes"]

src/Model/Results/Results.py

@@ -29,8 +29,134 @@ from Model.Results.River.River import River
 logger = logging.getLogger()
 
 
+class AdditionalData(SQLSubModel):
+    _sub_classes = []
+
+    def __init__(self, id=-1, study=None, data=None):
+        super(AdditionalData, self).__init__(
+            id=id, status=study.status,
+            owner_scenario=study.status.scenario.id
+        )
+
+        self._study = study
+        self._data = data
+
+    @property
+    def data(self):
+        return self._data
+
+    @classmethod
+    def _db_create(cls, execute, ext=""):
+        execute(f"""
+          CREATE TABLE results_add_data{ext} (
+            {cls.create_db_add_pamhyr_id()},
+            result INTEGER NOT NULL,
+            type_x TEXT NOT NULL,
+            type_y TEXT NOT NULL,
+            legend TEXT NOT NULL,
+            unit TEXT NOT NULL,
+            data_len INTEGER NOT NULL,
+            x BLOB NOT NULL,
+            y BLOB NOT NULL,
+            {Scenario.create_db_add_scenario()},
+            {Scenario.create_db_add_scenario_fk()},
+            FOREIGN KEY(result) REFERENCES results(pamhyr_id),
+            PRIMARY KEY(pamhyr_id, result, scenario)
+          )
+        """)
+
+        if ext != "":
+            return True
+
+        return cls._create_submodel(execute)
+
+    @classmethod
+    def _db_update(cls, execute, version, data=None):
+        major, minor, release = version.strip().split(".")
+
+        if major == "0" and int(minor) == 2 and int(release) <= 1:
+            cls._db_create(execute)
+
+        return cls._update_submodel(execute, version, data)
+
+    @classmethod
+    def _db_load(cls, execute, data=None):
+        new = []
+
+        study = data['study']
+        status = data['status']
+        scenario = data["scenario"]
+
+        table = execute(
+            "SELECT pamhyr_id, type_x, type_y, " +
+            "legend, unit, data_len, x, y, " +
+            "scenario " +
+            "FROM results_add_data " +
+            f"WHERE scenario = {scenario.id}"
+        )
+
+        if table is None:
+            return new
+
+        for v in table:
+            it = iter(v)
+
+            pid = next(it)
+            type_x = next(it)
+            type_y = next(it)
+            legend = next(it)
+            unit = next(it)
+            data_len = next(it)
+            bx = next(it)
+            by = next(it)
+            owner_scenario = next(it)
+
+            data_format = ">" + ''.join(itertools.repeat("d", data_len))
+            x = struct.unpack(data_format, bx)
+            y = struct.unpack(data_format, by)
+
+            data = {
+                'type_x': type_x,
+                'type_y': type_y,
+                'legend': legend,
+                'unit': unit,
+                'x': x, 'y': y
+            }
+
+            new_data = cls(study=study)
+            new_data._data = data
+            new.append(new_data)
+
+        return new
+
+    def _db_save(self, execute, data=None):
+        if self._status.scenario.id != self._owner_scenario:
+            return
+
+        pid = self._pamhyr_id
+        data_len = len(self._data["x"])
+
+        data_format = ">" + ''.join(itertools.repeat("d", data_len))
+        bx = struct.pack(data_format, *self._data["x"])
+        by = struct.pack(data_format, *self._data["y"])
+
+        execute(
+            "INSERT INTO " +
+            "results_add_data (pamhyr_id, result, " +
+            "type_x, type_y, " +
+            "legend, unit, data_len, x, y, " +
+            "scenario) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
+            self._pamhyr_id, data["result"],
+            self._data["type_x"], self._data["type_y"],
+            self._data["legend"], self._data["unit"],
+            data_len, bx, by, self._owner_scenario
+        )
+
+        return True
+
+
 class Results(SQLSubModel):
-    _sub_classes = [River]
+    _sub_classes = [River, AdditionalData]
 
     def __init__(self, id=-1, study=None, solver=None,
                  repertory="", name="0"):
@@ -50,6 +176,7 @@ class Results(SQLSubModel):
             # Keep results creation date
             "creation_date": datetime.now(),
             "study_revision": study.status.version,
+            "additional_data": [],
         }
 
         if solver is not None:
@@ -184,6 +311,11 @@ class Results(SQLSubModel):
             data["timestamps"] = sorted(ts)
             new_results._river = River._db_load(execute, data)
 
+            new_results.set(
+                "additional_data",
+                AdditionalData._db_load(execute, data)
+            )
+
             yield (solver_type, new_results)
 
     def _db_save_clear(self, execute, solver_type, data=None):
@@ -206,6 +338,11 @@ class Results(SQLSubModel):
                     f"WHERE scenario = {self._owner_scenario} " +
                     f"AND result = {pid}"
                 )
+                execute(
+                    "DELETE FROM results_add_data " +
+                    f"WHERE scenario = {self._owner_scenario} " +
+                    f"AND result = {pid}"
+                )
 
     def _db_save(self, execute, data=None):
         if self._status.scenario.id != self._owner_scenario:
@@ -238,4 +375,7 @@ class Results(SQLSubModel):
         data["result"] = self._pamhyr_id
         self._river._db_save(execute, data)
 
+        for add_data in self.get("additional_data"):
+            add_data._db_save(execute, data)
+
         return True

src/Model/Results/River/River.py

@@ -105,16 +105,6 @@ class Profile(SQLSubModel):
     @classmethod
     def _db_update(cls, execute, version, data=None):
         major, minor, release = version.strip().split(".")
-        create = False
-
-        if major == "0" and int(minor) < 2:
-            cls._db_create(execute)
-            create = True
-
-        if major == "0" and int(minor) == 2:
-            if int(release) < 1 and not create:
-                cls._db_create(execute)
-                create = True
 
         return cls._update_submodel(execute, version, data)
 

src/Model/River.py

@@ -59,6 +59,7 @@ from Model.LateralContributionsAdisTS.LateralContributionsAdisTSList \
     import LateralContributionsAdisTSList
 from Model.D90AdisTS.D90AdisTSList import D90AdisTSList
 from Model.DIFAdisTS.DIFAdisTSList import DIFAdisTSList
+from Model.GeoTIFF.GeoTIFFList import GeoTIFFList
 from Model.Results.Results import Results
 
 logger = logging.getLogger()
@@ -468,6 +469,7 @@ class River(Graph):
         LateralContributionsAdisTSList,
         D90AdisTSList,
         DIFAdisTSList,
+        GeoTIFFList,
         Results
     ]
 
@@ -505,6 +507,8 @@ class River(Graph):
         self._D90AdisTS = D90AdisTSList(status=self._status)
         self._DIFAdisTS = DIFAdisTSList(status=self._status)
 
+        self._geotiff = GeoTIFFList(status=self._status)
+
         self._results = {}
 
     @classmethod
@@ -617,6 +621,8 @@ class River(Graph):
 
         new._DIFAdisTS = DIFAdisTSList._db_load(execute, data)
 
+        new._geotiff = GeoTIFFList._db_load(execute, data)
+
         return new
 
     def _db_load_results(self, execute, data=None):
@@ -650,6 +656,8 @@ class River(Graph):
         objs.append(self._D90AdisTS)
         objs.append(self._DIFAdisTS)
 
+        objs.append(self._geotiff)
+
         for solv_type in self.results:
             objs.append(self.results[solv_type])
 
@@ -726,6 +734,7 @@ class River(Graph):
             self._BoundaryConditionsAdisTS,
             self._LateralContributionsAdisTS,
             self._D90AdisTS, self._DIFAdisTS,
+            self._geotiff,
         ]
 
         for solver in self._parameters:
@@ -818,6 +827,10 @@ Last export at: @date."""
     def additional_files(self):
         return self._additional_files
 
+    @property
+    def geotiff(self):
+        return self._geotiff
+
     @property
     def rep_lines(self):
         return self._rep_lines

src/Model/Study.py

@@ -37,7 +37,7 @@ logger = logging.getLogger()
 
 
 class Study(SQLModel):
-    _version = "0.2.1"
+    _version = "0.2.3"
 
     _sub_classes = [
         Scenario,