floodmodeller-api 0.5.0.post1__py3-none-any.whl → 0.5.1__py3-none-any.whl

floodmodeller_api/logs/lf_helpers.py

@@ -64,42 +64,40 @@ class AllData(Data):
         index_key: str | None = None,
         index_df: pd.Series | None = None,
     ) -> pd.DataFrame:
-        df = pd.DataFrame(self._value)
+        value_df = pd.DataFrame(self._value)
 
         # do nothing to empty dataframes
-        if df.empty:
-            return df
+        if value_df.empty:
+            return value_df
 
         # overall header
         if self._subheaders is None:
-            df.rename(columns={df.columns[0]: self.header}, inplace=True)
+            value_df = value_df.rename(columns={value_df.columns[0]: self.header})
 
         elif index_key is not None:
             # subheaders
-            df = df.set_axis(self._subheaders, axis=1)
+            value_df = value_df.set_axis(self._subheaders, axis=1)
 
             # remove duplicate of index
             # sometimes it includes extra values
             # it also has different precision
             index_duplicate = index_key + "_duplicate"
-            if index_duplicate in df.columns:
+            if index_duplicate in value_df.columns:
                 try:
-                    index_df = df[index_duplicate].dt.round("1s")
-                    df.drop(index_duplicate, axis=1, inplace=True)
+                    index_df = value_df[index_duplicate].dt.round("1s")
+                    value_df = value_df.drop(index_duplicate, axis=1)
                 except AttributeError:
-                    df = df.drop(columns=index_duplicate)
+                    value_df = value_df.drop(columns=index_duplicate)
 
         # there is no index because *this* is the index
         if index_key is None:
-            return df
+            return value_df
 
         # made lf index the dataframe index
-        df[index_key] = index_df
-        df.dropna(inplace=True)
-        df.drop_duplicates(subset=index_key, keep="last", inplace=True)
-        df.set_index(index_key, inplace=True)
-
-        return df
+        value_df[index_key] = index_df
+        value_df = value_df.dropna()
+        value_df = value_df.drop_duplicates(subset=index_key, keep="last")
+        return value_df.set_index(index_key)
 
 
 def data_factory(data_type: str, header: str, subheaders: list | None = None):
@@ -107,7 +105,8 @@ def data_factory(data_type: str, header: str, subheaders: list | None = None):
         return LastData(header, subheaders)
     if data_type == "all":
         return AllData(header, subheaders)
-    raise ValueError(f'Unexpected data "{data_type}"')
+    msg = f'Unexpected data "{data_type}"'
+    raise ValueError(msg)
 
 
 class State(ABC):
@@ -140,7 +139,8 @@ class SteadyState(State):
         pass
 
     def report_progress(self):
-        raise NotImplementedError("No progress reporting for steady simulations")
+        msg = "No progress reporting for steady simulations"
+        raise NotImplementedError(msg)
 
 
 def state_factory(steady: bool, extracted_data: Data) -> State:

floodmodeller_api/mapping.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from . import DAT, IED, IEF, INP, LF1, LF2, XML2D, ZZN

floodmodeller_api/test/__init__.py

@@ -1,4 +1,4 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
+sys.path.insert(0, str(Path(__file__).parent.parent))

floodmodeller_api/test/conftest.py

@@ -1,4 +1,3 @@
-import os
 from pathlib import Path
 from unittest.mock import patch
 
@@ -6,8 +5,8 @@ import pytest
 
 
 @pytest.fixture(scope="session")
-def test_workspace():
-    return Path(os.path.dirname(__file__), "test_data")
+def test_workspace() -> Path:
+    return Path(__file__).parent / "test_data"
 
 
 @pytest.fixture()

floodmodeller_api/test/test_backup.py

@@ -6,13 +6,13 @@ import pytest
 from floodmodeller_api.backup import BackupControl, File
 
 
-@pytest.fixture
+@pytest.fixture()
 def backup_control():
     # Use a different directory for testing
     return BackupControl()
 
 
-@pytest.fixture
+@pytest.fixture()
 def file(test_workspace):
     test_file = Path(test_workspace, "EX1.DAT")
     file = File(test_file)

floodmodeller_api/test/test_conveyance.py

@@ -38,7 +38,8 @@ def test_insert_intermediate_wls():
     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 result[0] == 1.0, "First element should match the input"
+    assert result[-1] == 3.0, "Last element should match the input"
     assert all(np.diff(result) <= threshold), "All gaps should be <= to the threshold"
 
 
@@ -52,7 +53,7 @@ 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"))
+@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
 
@@ -71,7 +72,7 @@ def test_results_close_to_gui(section: str, dat: DAT, from_gui: pd.DataFrame):
     assert hausdorff_distance < threshold
 
 
-@pytest.mark.parametrize("section", ("a", "a2", "b", "b2", "c", "d", "d2", "e", "e2", "e3"))
+@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

floodmodeller_api/test/test_dat.py

@@ -8,12 +8,12 @@ from floodmodeller_api.units import QTBDY
 from floodmodeller_api.util import FloodModellerAPIError
 
 
-@pytest.fixture
+@pytest.fixture()
 def dat_fp(test_workspace):
     return Path(test_workspace, "network.dat")
 
 
-@pytest.fixture
+@pytest.fixture()
 def data_before(dat_fp):
     return DAT(dat_fp)._write()
 

floodmodeller_api/test/test_data/structure_logs/EX17_expected.csv

@@ -0,0 +1,4 @@
+Unit Name,Unit Type,Unit Subtype,Comment,Friction,Dimensions (m),Weir Coefficient,Culvert Inlet/Outlet Loss
+T2,CONDUIT,RECTANGULAR,,"Mannings: [min: 0.010, max: 0.020]",h: 1.50 x w: 2.50 x l: 30.00 (Total conduit length: 30.00),,Ki: 0.6
+T2d,CONDUIT,RECTANGULAR,,"Mannings: [min: 0.010, max: 0.020]",h: 1.50 x w: 2.50 x l: 0.00,,Ko: 1.0
+S4_W,WEIR,,,,Crest Elevation: 49.45 x w: 4.00,,

floodmodeller_api/test/test_data/structure_logs/EX17_expected.json

@@ -0,0 +1,69 @@
+{
+    "(T2,CONDUIT)": {
+        "name": "T2",
+        "type": "CONDUIT",
+        "subtype": "RECTANGULAR",
+        "comment": "",
+        "conduit_data": {
+            "length": 30.0,
+            "inlet": 0.6,
+            "total_length": 30.0
+        },
+        "dimensions": {
+            "invert": 47.5,
+            "height": 1.5,
+            "width": 2.5
+        },
+        "friction": {
+            "friction_eq": "MANNING",
+            "friction_set": [
+                0.01,
+                0.015,
+                0.02
+            ],
+            "all_friction": [
+                0.01,
+                0.02,
+                0.015
+            ]
+        }
+    },
+    "(T2d,CONDUIT)": {
+        "name": "T2d",
+        "type": "CONDUIT",
+        "subtype": "RECTANGULAR",
+        "comment": "",
+        "conduit_data": {
+            "length": 0.0,
+            "outlet": 1.0
+        },
+        "dimensions": {
+            "invert": 47.47,
+            "height": 1.5,
+            "width": 2.5
+        },
+        "friction": {
+            "friction_eq": "MANNING",
+            "friction_set": [
+                0.01,
+                0.015,
+                0.02
+            ],
+            "all_friction": [
+                0.01,
+                0.02,
+                0.015
+            ]
+        }
+    },
+    "(S4_W,WEIR)": {
+        "name": "S4_W",
+        "type": "WEIR",
+        "subtype": null,
+        "comment": "",
+        "dimensions": {
+            "weir_elevation": 49.45,
+            "weir_breadth": 4.0
+        }
+    }
+}

floodmodeller_api/test/test_data/structure_logs/EX18_expected.csv

@@ -0,0 +1,20 @@
+Unit Name,Unit Type,Unit Subtype,Comment,Friction,Dimensions (m),Weir Coefficient,Culvert Inlet/Outlet Loss
+C2,CONDUIT,CIRCULAR,,"Mannings: [min: 0.015, max: 0.020]",dia: 1.00 x l: 100.00 (Total conduit length: 500.00),,Ki: 0.6
+C2_R1,REPLICATE,,,,,,
+C2_R2,REPLICATE,,,,,,
+C2_R3,REPLICATE,,,,,,
+C2_R4,REPLICATE,,,,,,
+C2m,CONDUIT,CIRCULAR,,"Mannings: [min: 0.015, max: 0.020]",dia: 1.00 x l: 0.00,,
+C2md,CONDUIT,CIRCULAR,,"Mannings: [min: 0.015, max: 0.020]",dia: 1.00 x l: 100.00 (Total conduit length: 700.00),,
+C2_R5,REPLICATE,,,,,,
+C2_R6,REPLICATE,,,,,,
+C2_R7,REPLICATE,,,,,,
+C2_R8,REPLICATE,,,,,,
+C2_R9,REPLICATE,,,,,,
+C2_R10,REPLICATE,,,,,,
+C2d,CONDUIT,CIRCULAR,,"Mannings: [min: 0.015, max: 0.020]",dia: 1.00 x l: 0.00,,
+S0,WEIR,,,,Crest Elevation: 21.00 x w: 1.50,,
+C2d,WEIR,,,,Crest Elevation: 18.00 x w: 0.60,,
+S4,WEIR,,,,Crest Elevation: 17.90 x w: 2.00,,
+S8,WEIR,,,,Crest Elevation: 17.70 x w: 2.00,,
+S3LS,SPILL,,,,Elevation: 20.00 x w: 100.00,1.7,

floodmodeller_api/test/test_data/structure_logs/EX18_expected.json

@@ -0,0 +1,292 @@
+{
+    "(C2,CONDUIT)": {
+        "name": "C2",
+        "type": "CONDUIT",
+        "subtype": "CIRCULAR",
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0,
+            "inlet": 0.6,
+            "total_length": 500.0
+        },
+        "dimensions": {
+            "invert": 20.0,
+            "diameter": 1.0
+        },
+        "friction": {
+            "friction_eq": "MANNING",
+            "friction_set": [
+                0.015,
+                0.02
+            ],
+            "all_friction": [
+                0.015,
+                0.02
+            ]
+        }
+    },
+    "(C2_R1,REPLICATE)": {
+        "name": "C2_R1",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2m"
+        }
+    },
+    "(C2_R2,REPLICATE)": {
+        "name": "C2_R2",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2m"
+        }
+    },
+    "(C2_R3,REPLICATE)": {
+        "name": "C2_R3",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2m"
+        }
+    },
+    "(C2_R4,REPLICATE)": {
+        "name": "C2_R4",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2m"
+        }
+    },
+    "(C2m,CONDUIT)": {
+        "name": "C2m",
+        "type": "CONDUIT",
+        "subtype": "CIRCULAR",
+        "comment": "",
+        "conduit_data": {
+            "length": 0.0
+        },
+        "dimensions": {
+            "invert": 19.2,
+            "diameter": 1.0
+        },
+        "friction": {
+            "friction_eq": "MANNING",
+            "friction_set": [
+                0.015,
+                0.02
+            ],
+            "all_friction": [
+                0.015,
+                0.02
+            ]
+        }
+    },
+    "(C2md,CONDUIT)": {
+        "name": "C2md",
+        "type": "CONDUIT",
+        "subtype": "CIRCULAR",
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0,
+            "total_length": 700.0
+        },
+        "dimensions": {
+            "invert": 19.2,
+            "diameter": 1.0
+        },
+        "friction": {
+            "friction_eq": "MANNING",
+            "friction_set": [
+                0.015,
+                0.02
+            ],
+            "all_friction": [
+                0.015,
+                0.02
+            ]
+        }
+    },
+    "(C2_R5,REPLICATE)": {
+        "name": "C2_R5",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2d"
+        }
+    },
+    "(C2_R6,REPLICATE)": {
+        "name": "C2_R6",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2d"
+        }
+    },
+    "(C2_R7,REPLICATE)": {
+        "name": "C2_R7",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2d"
+        }
+    },
+    "(C2_R8,REPLICATE)": {
+        "name": "C2_R8",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2d"
+        }
+    },
+    "(C2_R9,REPLICATE)": {
+        "name": "C2_R9",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2d"
+        }
+    },
+    "(C2_R10,REPLICATE)": {
+        "name": "C2_R10",
+        "type": "REPLICATE",
+        "subtype": null,
+        "comment": "",
+        "conduit_data": {
+            "length": 100.0
+        },
+        "dimensions": {
+            "bed_level_drop": 0.2,
+            "mimic": "C2d"
+        }
+    },
+    "(C2d,CONDUIT)": {
+        "name": "C2d",
+        "type": "CONDUIT",
+        "subtype": "CIRCULAR",
+        "comment": "",
+        "conduit_data": {
+            "length": 0.0
+        },
+        "dimensions": {
+            "invert": 18.0,
+            "diameter": 1.0
+        },
+        "friction": {
+            "friction_eq": "MANNING",
+            "friction_set": [
+                0.015,
+                0.02
+            ],
+            "all_friction": [
+                0.015,
+                0.02
+            ]
+        }
+    },
+    "(S0,WEIR)": {
+        "name": "S0",
+        "type": "WEIR",
+        "subtype": null,
+        "comment": "",
+        "dimensions": {
+            "weir_elevation": 21.0,
+            "weir_breadth": 1.5
+        }
+    },
+    "(C2d,WEIR)": {
+        "name": "C2d",
+        "type": "WEIR",
+        "subtype": null,
+        "comment": "",
+        "dimensions": {
+            "weir_elevation": 18.0,
+            "weir_breadth": 0.6
+        }
+    },
+    "(S4,WEIR)": {
+        "name": "S4",
+        "type": "WEIR",
+        "subtype": null,
+        "comment": "",
+        "dimensions": {
+            "weir_elevation": 17.9,
+            "weir_breadth": 2.0
+        }
+    },
+    "(S8,WEIR)": {
+        "name": "S8",
+        "type": "WEIR",
+        "subtype": null,
+        "comment": "",
+        "dimensions": {
+            "weir_elevation": 17.7,
+            "weir_breadth": 2.0
+        }
+    },
+    "(S3LS,SPILL)": {
+        "name": "S3LS",
+        "type": "SPILL",
+        "subtype": null,
+        "comment": "",
+        "dimensions": {
+            "invert": 20.0,
+            "width": 100.0,
+            "weir_coefficient": 1.7,
+            "section_data": {
+                "x": [
+                    0.0,
+                    100.0
+                ],
+                "y": [
+                    20.0,
+                    20.0
+                ]
+            }
+        }
+    }
+}

floodmodeller_api/test/test_data/structure_logs/EX6_expected.csv

@@ -0,0 +1,4 @@
+Unit Name,Unit Type,Unit Subtype,Comment,Friction,Dimensions (m),Weir Coefficient,Culvert Inlet/Outlet Loss
+P0000a,SLUICE,VERTICAL,,,Crest Elevation: 73.20 x w: 20.00 x l: 1.00,,
+P11951U,SLUICE,VERTICAL,,,Crest Elevation: 73.00 x w: 3.36 x l: 1.00,,
+P44865U,SLUICE,VERTICAL,,,Crest Elevation: 70.81 x w: 3.36 x l: 3.00,,

floodmodeller_api/test/test_data/structure_logs/EX6_expected.json

@@ -0,0 +1,35 @@
+{
+    "(P0000a,SLUICE)": {
+        "name": "P0000a",
+        "type": "SLUICE",
+        "subtype": "VERTICAL",
+        "comment": "",
+        "dimensions": {
+            "weir_length": 1.0,
+            "crest_elevation": 73.2,
+            "weir_breadth": 20.0
+        }
+    },
+    "(P11951U,SLUICE)": {
+        "name": "P11951U",
+        "type": "SLUICE",
+        "subtype": "VERTICAL",
+        "comment": "",
+        "dimensions": {
+            "weir_length": 1.0,
+            "crest_elevation": 73.0,
+            "weir_breadth": 3.36
+        }
+    },
+    "(P44865U,SLUICE)": {
+        "name": "P44865U",
+        "type": "SLUICE",
+        "subtype": "VERTICAL",
+        "comment": "",
+        "dimensions": {
+            "weir_length": 3.0,
+            "crest_elevation": 70.81,
+            "weir_breadth": 3.36
+        }
+    }
+}