floodmodeller-api 0.4.3__py3-none-any.whl → 0.4.4.post1__py3-none-any.whl

floodmodeller_api/inp.py

@@ -23,6 +23,7 @@ from ._base import FMFile
 from .units.helpers import _to_str, join_n_char_ljust
 from .urban1d import subsections
 from .urban1d.general_parameters import DEFAULT_OPTIONS
+from .util import handle_exception
 from .validation import _validate_unit
 
 
@@ -43,20 +44,18 @@ class INP(FMFile):
     _filetype: str = "INP"
     _suffix: str = ".inp"
 
+    @handle_exception(when="read")
     def __init__(self, inp_filepath: str | Path | None = None, from_json: bool = False):
-        try:
-            if from_json:
-                return
-            if inp_filepath is not None:
-                FMFile.__init__(self, inp_filepath)
-                self._read()
+        if from_json:
+            return
+        if inp_filepath is not None:
+            FMFile.__init__(self, inp_filepath)
+            self._read()
 
-            else:
-                self._create_from_blank()
+        else:
+            self._create_from_blank()
 
-            self._get_section_definitions()
-        except Exception as e:
-            self._handle_exception(e, when="read")
+        self._get_section_definitions()
 
     def _read(self):
         # Read INP file
@@ -66,73 +65,68 @@ class INP(FMFile):
         # Generate INP file structure
         self._update_inp_struct()
 
+    @handle_exception(when="write")
     def _write(self) -> str:
         """Returns string representation of the current INP data
 
         Returns:
             str: Full string representation of INP in its most recent state (including changes not yet saved to disk)
         """
-        try:
-            _validate_unit(self, urban=True)
+        _validate_unit(self, urban=True)
 
-            block_shift = 0  # Used to allow changes in the length of subsections.
+        block_shift = 0  # Used to allow changes in the length of subsections.
 
-            for block in self._inp_struct:
-                if block["Subsection_Type"] in subsections.SUPPORTED_SUBSECTIONS:
-                    subsection_data = self._raw_data[
-                        block["start"] + block_shift : block["end"] + 1 + block_shift
-                    ]
-                    prev_block_len = len(subsection_data)
-
-                    if (
-                        subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"]
-                        == "general"
-                    ):
-                        # General parameters
-
-                        if block["Subsection_Type"] == "[OPTIONS]":
-                            # Options subsection
-
-                            new_subsection_data = [
-                                "[OPTIONS]",
-                                ";;Option             Value",
-                            ]
-
-                            for param, value in self.options.items():
-                                if value is not None:
-                                    option_line = join_n_char_ljust(21, param.upper(), value)
-                                    new_subsection_data.append(option_line)
-
-                            new_subsection_data.append("")  # blank line before next section
-
-                    else:  # Of unit type
-                        subsection = getattr(
-                            self,
-                            subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]][
-                                "attribute"
-                            ],
-                        )  # Get unit object
-                        new_subsection_data = (
-                            subsection._write()
-                        )  # String representation of unit object
-
-                    new_block_len = len(new_subsection_data)
-
-                    self._raw_data[
-                        block["start"] + block_shift : block["end"] + 1 + block_shift
-                    ] = new_subsection_data  # Replace existing subsection with new subsection string
-                    block_shift += (
-                        new_block_len - prev_block_len
-                    )  # adjust block shift for change in number of lines in block
-
-            # Regenerate INP file structure
-            self._update_inp_struct()
-
-            # Write _raw_data out to INP file.
-            return "\n".join(self._raw_data) + "\n"
-
-        except Exception as e:
-            self._handle_exception(e, when="write")
+        for block in self._inp_struct:
+            if block["Subsection_Type"] in subsections.SUPPORTED_SUBSECTIONS:
+                subsection_data = self._raw_data[
+                    block["start"] + block_shift : block["end"] + 1 + block_shift
+                ]
+                prev_block_len = len(subsection_data)
+
+                if (
+                    subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"]
+                    == "general"
+                ):
+                    # General parameters
+
+                    if block["Subsection_Type"] == "[OPTIONS]":
+                        # Options subsection
+
+                        new_subsection_data = [
+                            "[OPTIONS]",
+                            ";;Option             Value",
+                        ]
+
+                        for param, value in self.options.items():
+                            if value is not None:
+                                option_line = join_n_char_ljust(21, param.upper(), value)
+                                new_subsection_data.append(option_line)
+
+                        new_subsection_data.append("")  # blank line before next section
+
+                else:  # Of unit type
+                    subsection = getattr(
+                        self,
+                        subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["attribute"],
+                    )  # Get unit object
+                    new_subsection_data = (
+                        subsection._write()
+                    )  # String representation of unit object
+
+                new_block_len = len(new_subsection_data)
+
+                self._raw_data[block["start"] + block_shift : block["end"] + 1 + block_shift] = (
+                    new_subsection_data  # Replace existing subsection with new subsection string
+                )
+                block_shift += (
+                    new_block_len - prev_block_len
+                )  # adjust block shift for change in number of lines in block
+
+        # Regenerate INP file structure
+        self._update_inp_struct()
+
+        # Write _raw_data out to INP file.
+        return "\n".join(self._raw_data) + "\n"
 
     def _create_from_blank(self):
         raise NotImplementedError(

floodmodeller_api/logs/__init__.py

@@ -1,2 +1,2 @@
-from .lf import LF1, LF2, lf_factory
+from .lf import LF1, LF2, create_lf
 from .lf_params import error_2d_dict

floodmodeller_api/logs/lf.py

@@ -16,11 +16,14 @@ address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London
 
 from __future__ import annotations
 
+import datetime as dt
+import time
 from typing import TYPE_CHECKING
 
 import pandas as pd
 
 from .._base import FMFile
+from ..util import handle_exception
 from .lf_helpers import state_factory
 from .lf_params import lf1_steady_data_to_extract, lf1_unsteady_data_to_extract, lf2_data_to_extract
 
@@ -28,6 +31,10 @@ if TYPE_CHECKING:
     from pathlib import Path
 
 
+OLD_FILE = 5
+LOG_TIMEOUT = 10
+
+
 class LF(FMFile):
     """Reads and processes Flood Modeller log file
 
@@ -40,24 +47,21 @@ class LF(FMFile):
         Initiates 'LF' class object
     """
 
+    @handle_exception(when="read")
     def __init__(
         self,
         lf_filepath: str | Path | None,
         data_to_extract: dict,
         steady: bool = False,
     ):
-        try:
-            FMFile.__init__(self, lf_filepath)
-
-            self._data_to_extract = data_to_extract
-            self._init_counters()
-            self._init_parsers()
-            self._state = state_factory(steady, self._extracted_data)
+        FMFile.__init__(self, lf_filepath)
 
-            self._read()
+        self._data_to_extract = data_to_extract
+        self._init_counters()
+        self._init_parsers()
+        self._state = state_factory(steady, self._extracted_data)
 
-        except Exception as e:
-            self._handle_exception(e, when="read")
+        self._read()
 
     def _read(self, force_reread: bool = False, suppress_final_step: bool = False):
         # Read LF file
@@ -311,10 +315,50 @@ class LF2(LF):
         super().__init__(lf_filepath, data_to_extract, steady=False)
 
 
-def lf_factory(filepath: str, suffix: str, steady: bool) -> LF:
-    if suffix == "lf1":
-        return LF1(filepath, steady)
-    if suffix == "lf2":
-        return LF2(filepath)
-    flow_type = "steady" if steady else "unsteady"
-    raise ValueError(f"Unexpected log file type {suffix} for {flow_type} flow")
+def create_lf(filepath: Path, suffix: str) -> LF1 | LF2 | None:
+    """Checks for a new log file, waiting for its creation if necessary"""
+
+    def _no_log_file(reason: str) -> None:
+        print(f"No progress bar as {reason}. Simulation will continue as usual.")
+
+    # ensure progress bar is supported
+    if suffix not in {"lf1", "lf2"}:
+        _no_log_file("log file must have suffix lf1 or lf2")
+        return None
+
+    # wait for log file to exist
+    log_file_exists = False
+    max_time = time.time() + LOG_TIMEOUT
+
+    while not log_file_exists:
+        time.sleep(0.1)
+
+        log_file_exists = filepath.is_file()
+
+        # timeout
+        if (not log_file_exists) and (time.time() > max_time):
+            _no_log_file("log file is expected but not detected")
+            return None
+
+    # wait for new log file
+    old_log_file = True
+    max_time = time.time() + LOG_TIMEOUT
+
+    while old_log_file:
+        time.sleep(0.1)
+
+        # difference between now and when log file was last modified
+        last_modified_timestamp = filepath.stat().st_mtime
+        last_modified = dt.datetime.fromtimestamp(last_modified_timestamp)
+        time_diff_sec = (dt.datetime.now() - last_modified).total_seconds()
+
+        # it's old if it's over OLD_FILE seconds old (TODO: is this robust?)
+        old_log_file = time_diff_sec > OLD_FILE
+
+        # timeout
+        if old_log_file and (time.time() > max_time):
+            _no_log_file("log file is from previous run")
+            return None
+
+    # create LF instance
+    return LF1(filepath) if suffix == "lf1" else LF2(filepath)

floodmodeller_api/test/conftest.py

@@ -1,5 +1,6 @@
 import os
 from pathlib import Path
+from unittest.mock import patch
 
 import pytest
 
@@ -7,3 +8,9 @@ import pytest
 @pytest.fixture(scope="session")
 def test_workspace():
     return Path(os.path.dirname(__file__), "test_data")
+
+
+@pytest.fixture()
+def log_timeout():
+    with patch("floodmodeller_api.logs.lf.LOG_TIMEOUT", new=0):
+        yield

floodmodeller_api/test/test_conveyance.py

@@ -0,0 +1,107 @@
+from pathlib import Path
+
+import numpy as np
+import pandas as pd
+import pytest
+from scipy.spatial.distance import directed_hausdorff
+from shapely.geometry import LineString, Polygon
+
+from floodmodeller_api import DAT
+from floodmodeller_api.units.conveyance import (
+    calculate_conveyance_by_panel,
+    calculate_conveyance_part,
+    calculate_cross_section_conveyance,
+    insert_intermediate_wls,
+)
+
+
+def test_calculate_cross_section_conveyance():
+    x = np.array([0, 1, 2, 3, 4])
+    y = np.array([5, 3, 1, 2, 6])
+    n = np.array([0.03, 0.03, 0.03, 0.03, 0.03])
+    panel_markers = np.array([False, False, False, False, False])
+    rpl = np.array([1.0, 1.0, 1.0, 1.0, 1.0])
+    result = calculate_cross_section_conveyance(x, y, n, rpl, panel_markers)
+
+    assert isinstance(result, pd.Series), "Result should be a pandas Series"
+    assert not result.empty, "Result should not be empty"
+
+
+def test_calculate_conveyance_by_panel():
+    x = np.array([0, 1, 2])
+    y = np.array([5, 3, 1])
+    n = np.array([0.03, 0.03])
+    rpl = 1.0
+    wls = np.array([1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0, 4.5, 5.0])
+
+    result = calculate_conveyance_by_panel(x, y, n, rpl, wls)
+
+    assert isinstance(result, list), "Result should be a list"
+    assert len(result) == len(wls), "Result length should match the length of water levels"
+    assert all(isinstance(val, float) for val in result), "All conveyance values should be floats"
+
+
+def test_calculate_conveyance_part():
+    wetted_polygon = Polygon([(1, 3), (2, 1), (3, 2), (4, 6), (1, 3)])
+    water_plane = LineString([(0, 3), (5, 3)])
+    glass_walls = LineString([(1, 3), (1, 7)]), LineString([(4, 6), (4, 7)])
+    x = np.array([1, 2, 3, 4])
+    n = np.array([0.03, 0.03, 0.03, 0.03])
+    rpl = 1.0
+
+    result = calculate_conveyance_part(wetted_polygon, water_plane, glass_walls, x, n, rpl)
+
+    assert isinstance(result, float), "Result should be a float"
+    assert result >= 0, "Conveyance should be non-negative"
+
+
+def test_insert_intermediate_wls():
+    arr = np.array([1.0, 2.0, 3.0])
+    threshold = 0.5
+
+    result = insert_intermediate_wls(arr, threshold)
+
+    assert isinstance(result, np.ndarray), "Result should be a numpy array"
+    assert result[0] == 1.0 and result[-1] == 3.0, "First and last elements should match the input"
+    assert all(np.diff(result) <= threshold), "All gaps should be <= to the threshold"
+
+
+@pytest.fixture(scope="module")
+def dat(test_workspace: Path):
+    return DAT(test_workspace / "conveyance_test.dat")
+
+
+@pytest.fixture(scope="module")
+def from_gui(test_workspace: Path):
+    return pd.read_csv(test_workspace / "expected_conveyance.csv")
+
+
+@pytest.mark.parametrize("section", ("a", "a2", "b", "b2", "c", "d", "d2", "e", "e2", "e3"))
+def test_results_close_to_gui(section: str, dat: DAT, from_gui: pd.DataFrame):
+    threshold = 6
+
+    actual = dat.sections[section].conveyance
+    expected = (
+        from_gui.set_index(f"{section}_stage")[f"{section}_conveyance"].dropna().drop_duplicates()
+    )
+    common_index = sorted(set(actual.index).union(expected.index))
+    actual_interpolated = actual.reindex(common_index).interpolate(method="slinear")
+    expected_interpolated = expected.reindex(common_index).interpolate(method="slinear")
+
+    u = np.array(list(zip(actual_interpolated.index, actual_interpolated)))
+    v = np.array(list(zip(expected_interpolated.index, expected_interpolated)))
+    hausdorff_distance = directed_hausdorff(u, v)[0]
+
+    assert hausdorff_distance < threshold
+
+
+@pytest.mark.parametrize("section", ("a", "a2", "b", "b2", "c", "d", "d2", "e", "e2", "e3"))
+def test_results_match_gui_at_shared_points(section: str, dat: DAT, from_gui: pd.DataFrame):
+    tolerance = 1e-2  # 0.001
+    actual = dat.sections[section].conveyance
+    expected = (
+        from_gui.set_index(f"{section}_stage")[f"{section}_conveyance"].dropna().drop_duplicates()
+    )
+    shared_index = sorted(set(actual.index).intersection(expected.index))
+    diff = expected[shared_index] - actual[shared_index]
+    assert (abs(diff) < tolerance).all()  # asserts all conveyance values within 0.001 difference

floodmodeller_api/test/test_dat.py

@@ -5,6 +5,7 @@ import pytest
 
 from floodmodeller_api import DAT
 from floodmodeller_api.units import QTBDY
+from floodmodeller_api.util import FloodModellerAPIError
 
 
 @pytest.fixture
@@ -125,28 +126,28 @@ def test_insert_unit_at(units, dat_ex6):
 def test_insert_unit_too_many_arguments_error(dat_ex6, units, kwargs):
     msg = (
         r"\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
-        r"\nAPI Error: Problem encountered when trying to insert unit DAT file .*\."
+        r"\nAPI Error: Problem encountered when trying to insert unit into DAT file .*\."
         r"\n"
         r"\nDetails: .*-floodmodeller_api/dat\.py-\d+"
         r"\nMsg: Only one of add_at, add_before, or add_after required"
         r"\n"
         r"\nFor additional support, go to: https://github\.com/People-Places-Solutions/floodmodeller-api"
     )
-    with pytest.raises(Exception, match=msg):
+    with pytest.raises(FloodModellerAPIError, match=msg):
         dat_ex6.insert_unit(units[0], **kwargs)
 
 
 def test_insert_unit_no_arguments_error(dat_ex6, units):
     msg = (
         r"\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
-        r"\nAPI Error: Problem encountered when trying to insert unit DAT file .*\."
+        r"\nAPI Error: Problem encountered when trying to insert unit into DAT file .*\."
         r"\n"
         r"\nDetails: .*-floodmodeller_api/dat\.py-\d+"
         r"\nMsg: No positional argument given\. Please provide either add_before, add_at or add_after"
         r"\n"
         r"\nFor additional support, go to: https://github\.com/People-Places-Solutions/floodmodeller-api"
     )
-    with pytest.raises(Exception, match=msg):
+    with pytest.raises(FloodModellerAPIError, match=msg):
         dat_ex6.insert_unit(units[0])
 
 

floodmodeller_api/test/test_data/conveyance_test.dat

@@ -0,0 +1,165 @@
+
+#REVISION#1
+        10     0.750     0.900     0.100     0.001        12SI
+    10.000     0.010     0.010     0.700     0.100     0.700     0.000
+RAD FILE
+
+END GENERAL
+RIVER
+SECTION
+a
+     0.000              0.0001      1000
+         6
+     0.000     3.000     0.030     1.000               0.000     0.000          
+     1.000     2.500     0.030     1.000               0.000     0.000          
+     2.000     2.200     0.030     1.000               0.000     0.000          
+     3.000     1.800     0.030     1.000               0.000     0.000          
+     4.000     3.500     0.030     1.000               0.000     0.000          
+     5.000     4.000     0.030     1.000               0.000     0.000          
+RIVER
+SECTION
+a2
+     0.000              0.0001      1000
+         6
+     0.000     3.000     0.030*    1.000               0.000     0.000          
+     1.000     2.500     0.030*    1.000               0.000     0.000          
+     2.000     2.200     0.030*    1.000               0.000     0.000          
+     3.000     1.800     0.030*    1.000               0.000     0.000          
+     4.000     3.500     0.030*    1.000               0.000     0.000          
+     5.000     4.000     0.030*    1.000               0.000     0.000          
+RIVER
+SECTION
+b
+     0.000              0.0001      1000
+         7
+     0.000     3.000     0.020     1.000               0.000     0.000          
+     0.000     2.300     0.040     1.000               0.000     0.000          
+     2.000     2.200     0.015     1.000               0.000     0.000          
+     3.000     1.800     0.015     1.000               0.000     0.000          
+     3.500     2.200     0.030     1.000               0.000     0.000          
+     4.000     3.500     0.030     1.000               0.000     0.000          
+     4.000     4.000     0.030     1.000               0.000     0.000          
+RIVER
+SECTION
+b2
+     0.000              0.0001      1000
+         7
+     0.000     3.000     0.020     1.000               0.000     0.000          
+     0.000     2.300     0.040     1.000               0.000     0.000          
+     2.000     2.200     0.015*    1.000               0.000     0.000          
+     3.000     1.800     0.015     1.000               0.000     0.000          
+     3.500     2.200     0.030     1.000               0.000     0.000          
+     4.000     3.500     0.030     1.000               0.000     0.000          
+     4.000     4.000     0.030     1.000               0.000     0.000          
+RIVER
+SECTION
+c
+     0.000              0.0001      1000
+         5
+     0.000     4.000     0.080     1.000               0.000     0.000          
+     1.000     3.000     0.050     1.000               0.000     0.000          
+     2.000     2.000     0.015     1.000               0.000     0.000          
+     3.000     3.000     0.100     1.000               0.000     0.000          
+     4.000     4.000     0.500     1.000               0.000     0.000          
+RIVER
+SECTION
+d
+     0.000              0.0001      1000
+        13
+     0.000     5.000     0.040     1.000               0.000     0.000          
+     1.000     2.000     0.040     1.000               0.000     0.000          
+     2.000     1.000     0.040     1.000               0.000     0.000          
+     3.000     0.500     0.040     1.000               0.000     0.000          
+     4.000     1.000     0.040     1.000               0.000     0.000          
+     5.000     4.000     0.100     1.000               0.000     0.000          
+     5.200     4.000     0.070     1.000               0.000     0.000          
+     6.000     1.000     0.070     1.000               0.000     0.000          
+     7.000     1.500     0.070     1.000               0.000     0.000          
+     8.000     2.000     0.070     1.000               0.000     0.000          
+     9.000     3.000     0.070     1.000               0.000     0.000          
+    10.000     4.500     0.070     1.000               0.000     0.000          
+    11.000     5.000     0.070     1.000               0.000     0.000          
+RIVER
+SECTION
+d2
+     0.000              0.0001      1000
+        13
+     0.000     5.000     0.040     1.000               0.000     0.000          
+     1.000     2.000     0.040     1.000               0.000     0.000          
+     2.000     1.000     0.040     1.000               0.000     0.000          
+     3.000     0.500     0.040     1.000               0.000     0.000          
+     4.000     1.000     0.040     1.000               0.000     0.000          
+     5.000     4.000     0.100*    1.000               0.000     0.000          
+     5.200     4.000     0.070     1.000               0.000     0.000          
+     6.000     1.000     0.070     1.000               0.000     0.000          
+     7.000     1.500     0.070     1.000               0.000     0.000          
+     8.000     2.000     0.070     1.000               0.000     0.000          
+     9.000     3.000     0.070     1.000               0.000     0.000          
+    10.000     4.500     0.070     1.000               0.000     0.000          
+    11.000     5.000     0.070     1.000               0.000     0.000          
+RIVER
+SECTION
+e
+     0.000              0.0001      1000
+         7
+    30.000    42.000     0.030     1.000               0.000     0.000          
+    31.000    40.000     0.030     1.000               0.000     0.000          
+    33.000    39.800     0.035     1.000               0.000     0.000          
+    36.000    39.700     0.035     1.100               0.000     0.000          
+    40.000    39.500     0.040     1.150               0.000     0.000          
+    45.000    41.000     0.045     3.000               0.000     0.000          
+    75.000    42.200     0.045     3.000               0.000     0.000          
+RIVER
+SECTION
+e2
+     0.000              0.0001      1000
+         7
+    30.000    42.000     0.030     1.000               0.000     0.000          
+    31.000    40.000     0.030     1.000               0.000     0.000          
+    33.000    39.800     0.035     1.000               0.000     0.000          
+    36.000    39.700     0.035     1.100               0.000     0.000          
+    40.000    39.500     0.040     1.150               0.000     0.000          
+    45.000    41.000     0.045*    3.000               0.000     0.000          
+    75.000    42.200     0.045     3.000               0.000     0.000          
+RIVER
+SECTION
+e3
+     0.000              0.0001      1000
+         7
+    30.000    42.000     0.030*    1.000               0.000     0.000          
+    31.000    40.000     0.030     1.000               0.000     0.000          
+    33.000    39.800     0.035     1.000               0.000     0.000          
+    36.000    39.700     0.035*    1.100               0.000     0.000          
+    40.000    39.500     0.040*    1.150               0.000     0.000          
+    45.000    41.000     0.045*    3.000               0.000     0.000          
+    75.000    42.200     0.045     3.000               0.000     0.000          
+INITIAL CONDITIONS
+ label   ?      flow     stage froude no  velocity     umode    ustate         z
+a            y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+a2           y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+b            y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+b2           y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+c            y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+d            y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+d2           y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+e            y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+e2           y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+e3           y     0.000     0.000     0.000     0.000     0.000     0.000     0.000
+GISINFO
+RIVER SECTION a 0 0 0 0 0
+RIVER SECTION a2 0 0 0 0 0
+RIVER SECTION b 0 0 0 0 0
+RIVER SECTION b2 0 0 0 0 0
+RIVER SECTION c 0 0 0 0 0
+RIVER SECTION d 0 0 0 0 0
+RIVER SECTION d2 0 0 0 0 0
+RIVER SECTION e 0 0 0 0 0
+RIVER SECTION e2 0 0 0 0 0
+RIVER SECTION e3 0 0 0 0 0
+a 0 0 0 0 0
+a2 0 0 0 0 0
+b 0 0 0 0 0
+b2 0 0 0 0 0
+c 0 0 0 0 0
+d 0 0 0 0 0
+d2 0 0 0 0 0