floodmodeller-api 0.4.4.post1__py3-none-any.whl → 0.5.0.post1__py3-none-any.whl

floodmodeller_api/test/test_river.py

@@ -0,0 +1,246 @@
+import pandas as pd
+import pytest
+
+from floodmodeller_api.units.sections import RIVER
+
+river_unit_data_cases = [
+    (
+        [
+            "RIVER normal case",
+            "SECTION",
+            "SomeUnit",
+            "     0.000            0.000100  1000.000",
+            "        5",
+            "     0.000        10     0.030     0.000                 0.0       0.0          ",
+            "     1.000         9     0.030     0.000                 0.0       0.0      LEFT",
+            "     2.000         5     0.030     0.000                 0.0       0.0          ",
+            "     3.000         6     0.030     0.000                 0.0       0.0     RIGHT",
+            "     4.000        10     0.030     0.000                 0.0       0.0          ",
+        ],
+        3,
+    ),
+    (
+        [
+            "RIVER close together",
+            "SECTION",
+            "AnotherUnit",
+            "     0.000            0.000100  1000.000",
+            "        3",
+            "     0.000        15     0.040     0.000                 0.0       0.0          ",
+            "     1.500         8     0.040     0.000                 0.0       0.0      LEFT",
+            "     3.000        12     0.040     0.000                 0.0       0.0     RIGHT",
+        ],
+        2,
+    ),
+    (
+        [
+            "RIVER double markers",
+            "SECTION",
+            "AnotherUnit",
+            "     0.000            0.000100  1000.000",
+            "        3",
+            "     0.000        15     0.040     0.000                 0.0       0.0          ",
+            "     1.500         8     0.040     0.000                 0.0       0.0      LEFT",
+            "     3.000        12     0.040     0.000                 0.0       0.0          ",
+            "     4.000        13     0.040     0.000                 0.0       0.0      LEFT",
+            "     5.000         2     0.040     0.000                 0.0       0.0          ",
+            "     6.000         1     0.040     0.000                 0.0       0.0          ",
+            "     7.000       254     0.040     0.000                 0.0       0.0     RIGHT",
+            "     8.000        21     0.040     0.000                 0.0       0.0          ",
+            "     9.000        76     0.040     0.000                 0.0       0.0     RIGHT",
+        ],
+        4,
+    ),
+]
+
+
+@pytest.mark.parametrize(("river_unit_data", "_"), river_unit_data_cases)
+def test_read_write(river_unit_data, _):
+    river_section_1 = RIVER(river_unit_data)
+    river_section_2 = RIVER(river_section_1._write())
+    assert river_section_1 == river_section_2
+
+
+@pytest.mark.parametrize(("river_unit_data", "expected_len"), river_unit_data_cases)
+def test_river_active_data(river_unit_data, expected_len):
+    river_section = RIVER(river_unit_data)
+    active_data = river_section.active_data
+
+    assert len(active_data) == expected_len
+    assert active_data.iloc[0].Deactivation == "LEFT"
+    assert active_data.iloc[-1].Deactivation == "RIGHT"
+    assert "LEFT" not in active_data.iloc[1:-1].Deactivation.to_list()
+    assert "RIGHT" not in active_data.iloc[1:-1].Deactivation.to_list()
+
+
+def test_edit_active_data():
+    unit = RIVER(
+        [
+            "RIVER normal case",
+            "SECTION",
+            "SomeUnit",
+            "     0.000            0.000100  1000.000",
+            "        5",
+            "     0.000        10     0.030     0.000                 0.0       0.0          ",
+            "     1.000         9     0.030     0.000                 0.0       0.0      LEFT",
+            "     2.000         5     0.030     0.000                 0.0       0.0          ",
+            "     3.000         6     0.030     0.000                 0.0       0.0     RIGHT",
+            "     4.000        10     0.030     0.000                 0.0       0.0          ",
+        ],
+    )
+    unit.active_data.iloc[0, 1] = 99
+    assert unit.data.iloc[1, 1] == 99
+    expected_row = "1.000    99.000     0.030     0.000               0.000     0.000      LEFT"
+    assert expected_row in str(unit)
+
+
+def test_active_data_with_no_markers():
+    unit = RIVER(
+        [
+            "RIVER normal case",
+            "SECTION",
+            "SomeUnit",
+            "     0.000            0.000100  1000.000",
+            "        5",
+            "     0.000        10     0.030",
+            "     1.000         9     0.030",
+            "     2.000         5     0.030",
+            "     3.000         6     0.030",
+            "     4.000        10     0.030",
+        ],
+    )
+    assert len(unit.active_data) == 5
+    unit.data.iloc[1, 8] = "LEFT"
+    unit.data.iloc[3, 8] = "RIGHT"
+    assert len(unit.active_data) == 3
+
+
+def test_create_from_blank():
+    blank_unit = RIVER()
+    assert len(blank_unit.data) == 0
+    assert len(blank_unit.active_data) == 0
+    assert blank_unit._write() == [
+        "RIVER ",
+        "SECTION",
+        "new_section                                                                         ",
+        "     0.000            0.000100  1000.000",
+        "         0",
+    ]
+
+
+def test_create_from_blank_with_params():
+    unit = RIVER(
+        name="for_test",
+        comment="testing",
+        spill1="t",
+        spill2="e",
+        lat1="s",
+        lat2="t",
+        lat3="i",
+        lat4="ng",
+        dist_to_next=55,
+        slope=0.00015,
+        density=1010.0,
+        data=pd.DataFrame(
+            {
+                "X": [0.0, 1.0, 2.0],
+                "Y": [5.0, 2.0, 5.0],
+                "Mannings n": [0.01, 0.01, 0.01],
+                "Panel": ["", "", ""],
+                "RPL": [0.0, 0.0, 0.0],
+                "Marker": ["", "", ""],
+                "Easting": [0.0, 0.0, 0.0],
+                "Northing": [0.0, 0.0, 0.0],
+                "Deactivation": ["", "", ""],
+                "SP. Marker": ["", "", ""],
+            },
+        ),
+    )
+
+    assert unit._write() == [
+        "RIVER testing",
+        "SECTION",
+        "for_test    t           e           s           t           i           ng          ",
+        "    55.000            0.000150  1010.000",
+        "         3",
+        "     0.000     5.000     0.010     0.000               0.000     0.000                    ",
+        "     1.000     2.000     0.010     0.000               0.000     0.000                    ",
+        "     2.000     5.000     0.010     0.000               0.000     0.000                    ",
+    ]
+
+
+def test_set_river_dataframe_correct():
+    unit = RIVER(
+        [
+            "RIVER normal case",
+            "SECTION",
+            "SomeUnit",
+            "     0.000            0.000100  1000.000",
+            "        5",
+            "     0.000        10     0.030",
+            "     1.000         9     0.030",
+            "     2.000         5     0.030",
+            "     3.000         6     0.030",
+            "     4.000        10     0.030",
+        ],
+    )
+
+    df = pd.DataFrame(
+        {
+            "X": [0.0, 1.0, 2.0],
+            "Y": [5.0, 2.0, 5.0],
+            "Mannings n": [0.01, 0.01, 0.01],
+            "Panel": ["", "", ""],
+            "RPL": [0.0, 0.0, 0.0],
+            "Marker": ["", "", ""],
+            "Easting": [0.0, 0.0, 0.0],
+            "Northing": [0.0, 0.0, 0.0],
+            "Deactivation": ["", "", ""],
+            "SP. Marker": ["", "", ""],
+        },
+    )
+
+    unit.data = df.copy()
+    pd.testing.assert_frame_equal(unit._data, df.copy())
+
+
+def test_set_river_dataframe_incorrect():
+    unit = RIVER()
+
+    df = pd.DataFrame(
+        {
+            "X": [0.0, 1.0, 2.0],
+            "Y": [5.0, 2.0, 5.0],
+            "Mannings n": [0.01, 0.01, 0.01],
+            "RPL": [0.0, 0.0, 0.0],
+            "Marker": ["", "", ""],
+            "Easting": [0.0, 0.0, 0.0],
+            "Deactivation": ["", "", ""],
+            "SP. Marker": ["", "", ""],
+        },
+    )
+
+    with pytest.raises(ValueError):
+        unit.data = df.copy()
+
+
+def test_set_river_dataframe_case_sensitivity():
+    unit = RIVER()
+
+    df = pd.DataFrame(
+        {
+            "x": [0.0, 1.0, 2.0],
+            "Y": [5.0, 2.0, 5.0],
+            "mANNINGs n": [0.01, 0.01, 0.01],
+            "Panel": ["", "", ""],
+            "RPL": [0.0, 0.0, 0.0],
+            "Marker": ["", "", ""],
+            "Easting": [0.0, 0.0, 0.0],
+            "Northing": [0.0, 0.0, 0.0],
+            "Deactivation": ["", "", ""],
+            "SP. Marker": ["", "", ""],
+        },
+    )
+
+    unit.data = df.copy()
+    pd.testing.assert_frame_equal(unit._data, df.copy())

floodmodeller_api/to_from_json.py

@@ -77,6 +77,7 @@ def recursive_to_json(obj: Any, is_top_level: bool = True) -> Any:  # noqa: PLR0
     """
     from ._base import FMFile
     from .backup import File
+    from .ief import FlowTimeProfile
     from .units import IIC
     from .units._base import Unit
     from .urban1d._base import UrbanSubsection, UrbanUnit
@@ -105,7 +106,10 @@ def recursive_to_json(obj: Any, is_top_level: bool = True) -> Any:  # noqa: PLR0
         return {key: recursive_to_json(value, is_top_level=False) for key, value in obj.items()}
 
     # Either a type of FM API Class
-    if isinstance(obj, (FMFile, Unit, IIC, File, UrbanSubsection, UrbanUnit)):  # noqa: RET503
+    if isinstance(
+        obj,
+        (FMFile, Unit, IIC, File, UrbanSubsection, UrbanUnit, FlowTimeProfile),
+    ):
         # Information from the flood modeller object will be included in the JSON output
         # slicing undertaken to remove quotation marks
         return_dict: dict[str, Any] = {"API Class": str(obj.__class__)[8:-2]}
@@ -118,6 +122,8 @@ def recursive_to_json(obj: Any, is_top_level: bool = True) -> Any:  # noqa: PLR0
 
         return return_dict
 
+    return None
+
 
 def from_json(obj: str | dict) -> dict:
     """

floodmodeller_api/tool.py

@@ -54,9 +54,7 @@ def validate_int(value):
     """
     if value.isdigit():
         return True
-    if value == "":
-        return True
-    return False
+    return value == ""
 
 
 def validate_float(value):
@@ -72,9 +70,7 @@ def validate_float(value):
         float(value)
         return True
     except ValueError:
-        if value == "":
-            return True
-        return False
+        return value == ""
 
 
 class Gui:
@@ -92,7 +88,7 @@ class Gui:
 
     """
 
-    def __init__(  # noqa: PLR0913
+    def __init__(
         self,
         master: tk.Tk,
         title: str,
@@ -145,12 +141,12 @@ class Gui:
             label.pack()
             # Conditional stuff to add validation for different data types.
             # This ensures that you can't enter text if the input should be a number, etc.
-            if data_type == str:
+            if data_type is str:
                 entry = tk.Entry(self.master)
-            elif data_type == int:
+            elif data_type is int:
                 entry = tk.Entry(self.master, validate="key")
                 entry.config(validatecommand=(entry.register(validate_int), "%P"))
-            elif data_type == float:
+            elif data_type is float:
                 entry = tk.Entry(self.master, validate="key")
                 entry.config(validatecommand=(entry.register(validate_float), "%P"))
             else:

floodmodeller_api/units/__init__.py

@@ -4,7 +4,17 @@ from .conduits import CONDUIT
 from .iic import IIC
 from .losses import BLOCKAGE, CULVERT
 from .sections import INTERPOLATE, REPLICATE, RIVER
-from .structures import BRIDGE, CRUMP, FLAT_V_WEIR, ORIFICE, OUTFALL, RNWEIR, SLUICE, SPILL, WEIR
+from .structures import (
+    BRIDGE,
+    CRUMP,
+    FLAT_V_WEIR,
+    ORIFICE,
+    OUTFALL,
+    RNWEIR,
+    SLUICE,
+    SPILL,
+    WEIR,
+)
 from .units import ALL_UNIT_TYPES, SUPPORTED_UNIT_TYPES, UNSUPPORTED_UNIT_TYPES
 from .unsupported import UNSUPPORTED
 from .variables import Variables