floodmodeller-api 0.5.3__tar.gz → 0.5.3.post1__tar.gz

{floodmodeller_api-0.5.3/floodmodeller_api.egg-info → floodmodeller_api-0.5.3.post1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: floodmodeller_api
-Version: 0.5.3
+Version: 0.5.3.post1
 Summary: Extends the functionality of Flood Modeller to python users
 Author: Jacobs
 Author-email: joe.pierce@jacobs.com

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post1}/floodmodeller_api/dat.py

@@ -571,9 +571,7 @@ class DAT(FMFile):
             raise Exception(msg)
         # Changes done to account for unit types with spaces/dashes eg Flat-V Weir
         unit_type_safe = unit_type.replace(" ", "_").replace("-", "_")
-        unit_group[unit_name] = eval(
-            f"units.{unit_type_safe}({unit_data}, {self._label_len})",
-        )
+        unit_group[unit_name] = getattr(units, unit_type_safe)(unit_data, self._label_len)
         self._all_units.append(unit_group[unit_name])
 
     def _process_unsupported_unit(self, unit_type, unit_data) -> None:

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post1}/floodmodeller_api/ied.py

@@ -183,7 +183,7 @@ class IED(FMFile):
                 if unit_name in unit_group:
                     msg = f'Duplicate label ({unit_name}) encountered within category: {units.SUPPORTED_UNIT_TYPES[block["Type"]]["group"]}'
                     raise Exception(msg)
-                unit_group[unit_name] = eval(f'units.{block["Type"]}({unit_data})')
+                unit_group[unit_name] = getattr(units, block["Type"])(unit_data)
 
                 self._all_units.append(unit_group[unit_name])
 

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post1}/floodmodeller_api/ief.py

@@ -18,6 +18,7 @@ from __future__ import annotations
 
 import csv
 import logging
+import re
 import subprocess
 import time
 from io import StringIO
@@ -98,6 +99,8 @@ class IEF(FMFile):
         self._ief_properties: list[str] = []
         self.EventData: dict[str, str] = {}
         self.flowtimeprofiles: list[FlowTimeProfile] = []
+
+        raw_eventdata: list[tuple[str, str]] = []
         for line in raw_data:
             # Handle any comments here (prefixed with ;)
             if line.lstrip().startswith(";"):
@@ -116,7 +119,7 @@ class IEF(FMFile):
                             event_data_title = value
                     else:
                         event_data_title = prev_comment
-                    self.eventdata[event_data_title] = value
+                    raw_eventdata.append((event_data_title, value))
                     self._ief_properties.append("EventData")
 
                 elif prop.upper().startswith("FLOWTIMEPROFILE"):
@@ -134,6 +137,7 @@ class IEF(FMFile):
                 self._ief_properties.append(line)
                 prev_comment = None
 
+        self._eventdata_read_helper(raw_eventdata)
         self._check_formatting(raw_data)
         self._update_ief_properties()  # call this here to ensure ief properties is correct
 
@@ -179,7 +183,10 @@ class IEF(FMFile):
                 # Add multiple EventData if present
                 for idx, key in enumerate(event_data):
                     if idx == event_index:
-                        ief_string += f";{key}\nEventData{eq}{event_data[key]!s}\n"
+                        # we enter this block if we're ready to write the event data
+                        # scrub off any extra bits we've added as part of the make-unique bit of reading.
+                        title = re.sub(r"<\d>$", "", key)
+                        ief_string += f";{title}\nEventData{eq}{event_data[key]!s}\n"
                         break
                 event_index += 1
 
@@ -328,6 +335,16 @@ class IEF(FMFile):
                     if removed == to_remove:
                         break
 
+    def _eventdata_read_helper(self, raw_eventdata: list[tuple[str, str]]) -> None:
+        # now we deal with the event data, and convert it into the dict-based .eventdata
+        for title, ied_path in raw_eventdata:
+            n = 0
+            new_title = title or "<0>"  # set empty string to placeholder
+            while new_title in self.eventdata:
+                new_title = f"{title}<{n}>"
+                n += 1
+            self.eventdata[new_title] = ied_path
+
     def _update_flowtimeprofile_info(self) -> None:
         """Update the flowtimeprofile data stored in ief properties"""
         if not hasattr(self, "flowtimeprofiles") or len(self.flowtimeprofiles) == 0:
@@ -570,7 +587,7 @@ class IEF(FMFile):
 
         return ZZN(result_path)
 
-    def get_log(self):
+    def get_log(self) -> LF1:
         """If log files for the simulation exist, this function returns them as a LF1 class object
 
         Returns:

floodmodeller_api-0.5.3.post1/floodmodeller_api/test/test_data/multievent.ief

@@ -0,0 +1,43 @@
+[ISIS Event Header]
+Title=Multievent Test IEF
+Datafile=network.dat
+Results=..\Somewhere
+[ISIS Event Details]
+RunType=Unsteady
+InitialConditions=..\initial_conditions.iic
+Start=0
+Finish=360
+InitialTimestep=10
+MinimumTimestep=10
+MaximumTimestep=10
+SaveInterval=900
+;Fluvial Inflow
+EventData=..\network.ied
+;Event Override
+EventData=..\event_override.ied
+;Spill Data
+EventData=..\spill1.ied
+;Spill Data
+EventData=..\spill2.ied
+;
+EventData=..\ied_01.IED
+;
+EventData=..\ied_02.IED
+;
+EventData=..\ied_03.IED
+Dflood=5
+Qtol=0.1
+Minitr=5
+Maxitr=19
+Theta=0.55
+Weight=0.1
+AdaptiveTimestep=1
+RefineBridgeSecProps=0
+SolveDHEqualsZeroAtStart=1
+RulesAtTimeZero=1
+RulesOnFirstIteration=0
+ResetTimesAfterPos=1
+UseFPSModularLimit=1
+LaunchDoublePrecisionVersion=1
+UseRemoteQ=1
+2DFLOW=1

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post1}/floodmodeller_api/test/test_ief.py

@@ -18,6 +18,11 @@ def ief(ief_fp: Path) -> IEF:
     return IEF(ief_fp)
 
 
+@pytest.fixture()
+def multievent_ief(test_workspace: Path) -> IEF:
+    return IEF(test_workspace / "multievent.ief")
+
+
 @pytest.fixture()
 def exe_bin(tmpdir) -> Path:
     for exe in ["ISISf32.exe", "ISISf32_DoubleP.exe"]:
@@ -40,6 +45,7 @@ def sleep():
 
 def test_ief_read_doesnt_change_data(test_workspace, tmpdir):
     """IEF: Check all '.ief' files in folder by reading the _write() output into a new IEF instance and checking it stays the same."""
+    # we use this instead of parameterise so it will just automatically test any ief in the test data.
     for ief_file in Path(test_workspace).glob("*.ief"):
         ief = IEF(ief_file)
         first_output = ief._write()
@@ -182,3 +188,64 @@ def test_datafile_path(test_workspace: Path):
     path = Path(ief.Datafile)
     assert path.stem == "UptonP8_Panels"
     assert path.parent == Path("../../networks")
+
+
+def test_unique_events_retained(multievent_ief: IEF):
+    """Tests that the .eventdata attribute retains the same number of items as the original ief"""
+    event_dict = multievent_ief.eventdata
+    assert len(event_dict) == 7
+
+
+@pytest.mark.parametrize(
+    ("sample_eventdata"),
+    [
+        ({}),
+        ({"Fluvial Inflow": "..\\network.ied", "Event Override": "..\\event_override.ied"}),
+        (
+            {
+                "Fluvial Inflow": "..\\network.ied",
+                "Event Override": "..\\event_override.ied",
+                "Spill Data": "..\\spill1.ied",
+                "Spill Data<0>": "..\\spill2.ied",
+                "<0>": "..\\ied_01.IED",
+                "<1>": "..\\ied_02.IED",
+                "<2>": "..\\ied_03.IED",
+                "Added Event": "../added.ied",
+            }
+        ),
+    ],
+)
+def test_adding_eventdata(multievent_ief, sample_eventdata, tmpdir):
+    """Tests modifying, saving and reading eventdata dictionary.
+
+    Compares that the input is equal to the output."""
+    multievent_ief.eventdata = sample_eventdata
+    new_path = Path(tmpdir) / "tmp.ief"
+    multievent_ief.save(new_path)
+
+    new_ief = IEF(new_path)
+    assert new_ief.eventdata == sample_eventdata
+
+
+def test_renaming_eventdata(multievent_ief, tmpdir):
+    """Tests renaming an event, after it has been substituted for a temporary one."""
+
+    mapping = {"<1>": "New Title"}
+
+    multievent_ief.eventdata = {
+        mapping.get(key, key): value for key, value in multievent_ief.eventdata.items()
+    }
+    new_path = Path(tmpdir) / "tmp.ief"
+    multievent_ief.save(new_path)
+
+    new_ief = IEF(new_path)
+
+    assert new_ief.eventdata == {
+        "Fluvial Inflow": "..\\network.ied",
+        "Event Override": "..\\event_override.ied",
+        "Spill Data": "..\\spill1.ied",
+        "Spill Data<0>": "..\\spill2.ied",
+        "<0>": "..\\ied_01.IED",
+        "New Title": "..\\ied_02.IED",
+        "<1>": "..\\ied_03.IED",
+    }

floodmodeller_api-0.5.3.post1/floodmodeller_api/test/test_sluice.py

@@ -0,0 +1,31 @@
+from floodmodeller_api.units import SLUICE
+
+
+def test_non_supported_sluice_type_writes():
+    unit_block = [
+        "SLUICE Sluice with type Water1",
+        "VERTICAL",
+        "USNODE      DSNODE                 ",
+        "     0.700     0.700     1.950     1.050     1.390     5.400",
+        "     0.270     1.420     1.000     1.000     0.000     1.000     1.000",
+        "         3SECONDS   EXTEND    ",
+        "WATER1                             0.000",
+        "GATE      1                                                                     ",
+        "         3",
+        "     0.000     2.200",
+        "     3.000     2.200",
+        "1.000e+010     2.200",
+        "GATE      2                                                                     ",
+        "         3",
+        "     0.000     2.200",
+        "     3.000     2.200",
+        "1.000e+010     2.200",
+        "GATE      3                                                                     ",
+        "         3",
+        "     0.000     2.200",
+        "     3.000     2.200",
+        "1.000e+010     2.200",
+    ]
+    sluice = SLUICE(unit_block)
+    result = sluice._write()
+    assert list(map(str.rstrip, result)) == list(map(str.rstrip, unit_block))

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post1}/floodmodeller_api/units/structures.py

@@ -696,7 +696,7 @@ class SLUICE(Unit):
             )
 
         # Third parameter line
-        self.ngates = len(self.gates)
+        self.ngates = len(self.gates) if hasattr(self, "gates") else self.ngates
         params3 = join_10_char(self.ngates)
 
         if self.subtype == "RADIAL":

floodmodeller_api-0.5.3.post1/floodmodeller_api/version.py

@@ -0,0 +1 @@
+__version__ = "0.5.3.post1"

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post1/floodmodeller_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: floodmodeller_api
-Version: 0.5.3
+Version: 0.5.3.post1
 Summary: Extends the functionality of Flood Modeller to python users
 Author: Jacobs
 Author-email: joe.pierce@jacobs.com

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post1}/floodmodeller_api.egg-info/SOURCES.txt

@@ -60,6 +60,7 @@ floodmodeller_api/test/test_json.py
 floodmodeller_api/test/test_logs_lf.py
 floodmodeller_api/test/test_read_file.py
 floodmodeller_api/test/test_river.py
+floodmodeller_api/test/test_sluice.py
 floodmodeller_api/test/test_tool.py
 floodmodeller_api/test/test_toolbox_structure_log.py
 floodmodeller_api/test/test_unit.py
@@ -162,6 +163,7 @@ floodmodeller_api/test/test_data/hplus_export_example_9.csv
 floodmodeller_api/test/test_data/integrated_bridge.dat
 floodmodeller_api/test/test_data/jump.dat
 floodmodeller_api/test/test_data/lf_complex_ex.lf1
+floodmodeller_api/test/test_data/multievent.ief
 floodmodeller_api/test/test_data/network.dat
 floodmodeller_api/test/test_data/network.ext
 floodmodeller_api/test/test_data/network.exy

floodmodeller_api-0.5.3/floodmodeller_api/version.py

@@ -1 +0,0 @@
-__version__ = "0.5.3"