floodmodeller-api 0.4.2__py3-none-any.whl → 0.4.3__py3-none-any.whl

floodmodeller_api/units/units.py

@@ -1,102 +1,93 @@
-"""
-Flood Modeller Python API
-Copyright (C) 2023 Jacobs U.K. Limited
-
-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/.
-
-If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following
-address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
-"""
-
-
-# Unit types and support
-SUPPORTED_UNIT_TYPES = {
-    "QTBDY": {"group": "boundaries", "has_subtype": False},
-    "HTBDY": {"group": "boundaries", "has_subtype": False},
-    "QHBDY": {"group": "boundaries", "has_subtype": False},
-    "REFHBDY": {"group": "boundaries", "has_subtype": False},
-    "RIVER": {"group": "sections", "has_subtype": True},
-    "BRIDGE": {"group": "structures", "has_subtype": True},
-    "CONDUIT": {"group": "conduits", "has_subtype": True},
-    "SLUICE": {"group": "structures", "has_subtype": True},
-    "ORIFICE": {"group": "structures", "has_subtype": True},
-    "SPILL": {"group": "structures", "has_subtype": False},
-    "INITIAL CONDITIONS": {"group": "other", "has_subtype": False},
-    "VARIABLES": {"group": "other", "has_subtype": False},
-    "BLOCKAGE": {"group": "losses", "has_subtype": False},
-    "CULVERT": {"group": "losses", "has_subtype": True},
-    "RNWEIR": {"group": "structures", "has_subtype": False},
-    "WEIR": {"group": "structures", "has_subtype": False},  # general weir
-    "CRUMP": {"group": "structures", "has_subtype": False},
-    "FLAT-V WEIR": {"group": "structures", "has_subtype": False},
-    # "RESERVOIR": {"group":"structures", "has_subtype": False}, # Needs further testing
-    "INTERPOLATE": {"group": "sections", "has_subtype": False},
-    "REPLICATE": {"group": "sections", "has_subtype": False},
-    "OUTFALL": {"group": "structures", "has_subtype": True},
-    "COMMENT": {"group": "comments", "has_subtype": False},
-}
-
-UNSUPPORTED_UNIT_TYPES = {
-    # "ASYMMETRIC" : CONDUIT
-    "ABSTRACTION": {"has_subtype": False},
-    # "BEND": CULVERT
-    "BERNOULLI": {"has_subtype": False},
-    "BREACH": {"has_subtype": False},  # breach
-    # "CES": RIVER
-    # "COMMENT": {"group": "other", "has_subtype": False},
-    # "CONPUMP": {"group": ,"has_subtype": }, ### Konrad Adams to confirm whether these are still used
-    # "CONVALVE": {"group": ,"has_subtype": }, ### Konrad Adams to confirm whether these are still used
-    "FEHBDY": {"group": "boundaries", "has_subtype": False},  # RAINFALL RUNOFF METHOD boundary
-    "FLOOD RELIEF": {"has_subtype": True},  # found in dat file
-    "FLOOD RELIEF ARCH": {"group": "structures", "has_subtype": True},  # found in FM help
-    "FLOODPLAIN": {"has_subtype": True},  # floodplain section culvert
-    "FRQSIM": {"group": "boundaries", "has_subtype": False},  # flood FReQuency SIMulation
-    "FSRBDY": {
-        "group": "boundaries",
-        "has_subtype": False,
-    },  # FEH Method (FEH Rainfall Runoff Method)
-    "FSSR16BDY": {"group": "boundaries", "has_subtype": False},  # FSSR16 Method
-    # "FULLARCH": CONDUIT
-    "GATED WEIR": {"group": "structures", "has_subtype": False},  # gated weir
-    "GAUGE": {"has_subtype": False},  # Gauge
-    "GERRBDY": {"group": "boundaries", "has_subtype": False},  # gen rainfall runoff
-    "INVERTED SYPHON": {"group": "structures", "has_subtype": True},  # invert syphon
-    "JUNCTION": {"has_subtype": True},  # [connector]
-    "LABYRINTH WEIR": {"group": "structures", "has_subtype": False},  # labyrinth weir
-    "LATERAL": {"has_subtype": False},  # [connector]
-    # "LDPUMP": {"group": ,"has_subtype": }, #can still be read - v similar to OCPUMP
-    "LOSS": {"has_subtype": False},  # found in .dat
-    "LOSSID": {"has_subtype": False},  # found in .dat
-    "MANHOLE": {"has_subtype": False},  # Manhole [connector]
-    # "MUSKINGUM": RIVER
-    # "MUSK-RSEC": RIVER
-    # "MUSK-VPMC": RIVER
-    # "MUSK-XSEC": RIVER
-    "NCDBDY": {"group": "boundaries", "has_subtype": False},  # Normal/Critical Depth Boundary
-    "NOTWEIR": {"group": "structures", "has_subtype": False},  # Notional Weir
-    "OCPUMP": {"has_subtype": False},  # pump [junctions]
-    "POND": {"has_subtype": True},  # Pond units, online pond etc [connector]
-    "QH CONTROL": {"group": "structures", "has_subtype": False},  # Flow-head control weir
-    "QRATING": {"group": "boundaries", "has_subtype": False},  # Rating Curves
-    "REBDY": {"group": "boundaries", "has_subtype": False},  # Rainfall/Evaporation Boundary
-    "REFH2BDY": {"group": "boundaries", "has_subtype": False},  # ReFH2 Method
-    "RESERVOIR": {"has_subtype": False},  # reservoir unit [connector]
-    # "SECTION": CONDUIT
-    "SCSBDY": {
-        "group": "boundaries",
-        "has_subtype": False,
-    },  # US SCS Method now SS for rainfall/runoff
-    "SCWEIR": {"group": "structures", "has_subtype": False},  # sharp crested weir
-    # "SPRUNG": CONDUIT
-    "SYPHON": {"group": "structures", "has_subtype": False},  # syphon unit
-    # "TIDAL": {"has_subtype": }, #can still be read - similar to TIDBY
-    "TIDBDY": {"group": "boundaries", "has_subtype": False},  # tidal
-}
-
-ALL_UNIT_TYPES = set(SUPPORTED_UNIT_TYPES.keys()).union(UNSUPPORTED_UNIT_TYPES)
+"""
+Flood Modeller Python API
+Copyright (C) 2024 Jacobs U.K. Limited
+
+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/.
+
+If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following
+address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
+"""
+
+from typing import TypedDict
+
+
+class UnitTypes(TypedDict):
+    group: str
+    has_subtype: bool
+
+
+# Unit types and support
+SUPPORTED_UNIT_TYPES: dict[str, UnitTypes] = {
+    "QTBDY": {"group": "boundaries", "has_subtype": False},
+    "HTBDY": {"group": "boundaries", "has_subtype": False},
+    "QHBDY": {"group": "boundaries", "has_subtype": False},
+    "REFHBDY": {"group": "boundaries", "has_subtype": False},
+    "RIVER": {"group": "sections", "has_subtype": True},
+    "BRIDGE": {"group": "structures", "has_subtype": True},
+    "CONDUIT": {"group": "conduits", "has_subtype": True},
+    "SLUICE": {"group": "structures", "has_subtype": True},
+    "ORIFICE": {"group": "structures", "has_subtype": True},
+    "SPILL": {"group": "structures", "has_subtype": False},
+    "INITIAL CONDITIONS": {"group": "other", "has_subtype": False},
+    "VARIABLES": {"group": "other", "has_subtype": False},
+    "BLOCKAGE": {"group": "losses", "has_subtype": False},
+    "CULVERT": {"group": "losses", "has_subtype": True},
+    "RNWEIR": {"group": "structures", "has_subtype": False},
+    "WEIR": {"group": "structures", "has_subtype": False},  # general weir
+    "CRUMP": {"group": "structures", "has_subtype": False},
+    "FLAT-V WEIR": {"group": "structures", "has_subtype": False},
+    "INTERPOLATE": {"group": "sections", "has_subtype": False},
+    "REPLICATE": {"group": "sections", "has_subtype": False},
+    "OUTFALL": {"group": "structures", "has_subtype": True},
+    "COMMENT": {"group": "comments", "has_subtype": False},
+}
+
+UNSUPPORTED_UNIT_TYPES = {
+    "ABSTRACTION": {"has_subtype": False},
+    "BERNOULLI": {"has_subtype": False},
+    "BREACH": {"has_subtype": False},  # breach
+    "FEHBDY": {"group": "boundaries", "has_subtype": False},  # RAINFALL RUNOFF METHOD boundary
+    "FLOOD RELIEF": {"has_subtype": True},  # found in dat file
+    "FLOOD RELIEF ARCH": {"group": "structures", "has_subtype": True},  # found in FM help
+    "FLOODPLAIN": {"has_subtype": True},  # floodplain section culvert
+    "FRQSIM": {"group": "boundaries", "has_subtype": False},  # flood FReQuency SIMulation
+    "FSRBDY": {
+        "group": "boundaries",
+        "has_subtype": False,
+    },  # FEH Method (FEH Rainfall Runoff Method)
+    "FSSR16BDY": {"group": "boundaries", "has_subtype": False},  # FSSR16 Method
+    "GATED WEIR": {"group": "structures", "has_subtype": False},  # gated weir
+    "GAUGE": {"has_subtype": False},  # Gauge
+    "GERRBDY": {"group": "boundaries", "has_subtype": False},  # gen rainfall runoff
+    "INVERTED SYPHON": {"group": "structures", "has_subtype": True},  # invert syphon
+    "JUNCTION": {"has_subtype": True},  # [connector]
+    "LABYRINTH WEIR": {"group": "structures", "has_subtype": False},  # labyrinth weir
+    "LATERAL": {"has_subtype": False},  # [connector]
+    "LOSS": {"has_subtype": False},  # found in .dat
+    "LOSSID": {"has_subtype": False},  # found in .dat
+    "MANHOLE": {"has_subtype": False},  # Manhole [connector]
+    "NCDBDY": {"group": "boundaries", "has_subtype": False},  # Normal/Critical Depth Boundary
+    "NOTWEIR": {"group": "structures", "has_subtype": False},  # Notional Weir
+    "OCPUMP": {"has_subtype": False},  # pump [junctions]
+    "POND": {"has_subtype": True},  # Pond units, online pond etc [connector]
+    "QH CONTROL": {"group": "structures", "has_subtype": False},  # Flow-head control weir
+    "QRATING": {"group": "boundaries", "has_subtype": False},  # Rating Curves
+    "REBDY": {"group": "boundaries", "has_subtype": False},  # Rainfall/Evaporation Boundary
+    "REFH2BDY": {"group": "boundaries", "has_subtype": False},  # ReFH2 Method
+    "RESERVOIR": {"has_subtype": False},  # reservoir unit [connector]
+    "SCSBDY": {
+        "group": "boundaries",
+        "has_subtype": False,
+    },  # US SCS Method now SS for rainfall/runoff
+    "SCWEIR": {"group": "structures", "has_subtype": False},  # sharp crested weir
+    "SYPHON": {"group": "structures", "has_subtype": False},  # syphon unit
+    "TIDBDY": {"group": "boundaries", "has_subtype": False},  # tidal
+}
+
+ALL_UNIT_TYPES = set(SUPPORTED_UNIT_TYPES.keys()).union(UNSUPPORTED_UNIT_TYPES)

floodmodeller_api/units/unsupported.py

@@ -1,44 +1,44 @@
-"""
-Flood Modeller Python API
-Copyright (C) 2023 Jacobs U.K. Limited
-
-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/.
-
-If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following
-address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
-"""
-
-from ._base import Unit
-from .helpers import split_n_char
-
-
-class UNSUPPORTED(Unit):
-    """Used to read in all unsupported unit types, simply returning the raw data on write"""
-
-    def _read(self, block, unit_name, unit_type, subtype):
-        self.name = unit_name
-        self._unit = unit_type
-        self._subtype = subtype
-        self._raw_block = block
-        self.comment = block[0].replace(self._unit, "").strip()
-
-        if self._subtype is False:
-            self.labels = split_n_char(f"{block[1]:<{2*self._label_len}}", self._label_len)
-
-        else:
-            self._subtype = block[1].split(" ")[0].strip()
-            if self._unit == "JUNCTION":
-                self.labels = split_n_char(block[2], self._label_len)
-            self.labels = split_n_char(f"{block[2]:<{2*self._label_len}}", self._label_len)
-
-        if self.labels[1] != "" and self._unit != "JUNCTION":
-            self.ds_label = self.labels[1]
-
-    def _write(self):
-        return self._raw_block
+"""
+Flood Modeller Python API
+Copyright (C) 2024 Jacobs U.K. Limited
+
+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/.
+
+If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following
+address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
+"""
+
+from ._base import Unit
+from .helpers import split_n_char
+
+
+class UNSUPPORTED(Unit):
+    """Used to read in all unsupported unit types, simply returning the raw data on write"""
+
+    def _read(self, block, unit_name, unit_type, subtype):
+        self.name = unit_name
+        self._unit = unit_type
+        self._subtype = subtype
+        self._raw_block = block
+        self.comment = block[0].replace(self._unit, "").strip()
+
+        if self._subtype is False:
+            self.labels = split_n_char(f"{block[1]:<{2*self._label_len}}", self._label_len)
+
+        else:
+            self._subtype = block[1].split(" ")[0].strip()
+            if self._unit == "JUNCTION":
+                self.labels = split_n_char(block[2], self._label_len)
+            self.labels = split_n_char(f"{block[2]:<{2*self._label_len}}", self._label_len)
+
+        if self.labels[1] != "" and self._unit != "JUNCTION":
+            self.ds_label = self.labels[1]
+
+    def _write(self):
+        return self._raw_block

floodmodeller_api/units/variables.py

@@ -1,89 +1,87 @@
-"""
-Flood Modeller Python API
-Copyright (C) 2023 Jacobs U.K. Limited
-
-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/.
-
-If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following
-address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
-"""
-
-import pandas as pd
-
-from ..diff import check_item_with_dataframe_equal
-from .helpers import join_10_char
-
-# Variables, Rules & Varrules Classes
-
-
-class Variables:
-    """Class to hold VARIABLES"""
-
-    def __init__(self, var_block):
-        self._read(var_block)
-
-    def __repr__(self):
-        return "<floodmodeller_api Variables Class: Variables()>"
-
-    def _read(self, var_block):
-        header = [
-            "name",
-            "type",
-            "initial value",
-            "initial status",
-        ]
-        data_list = []
-        for line in var_block[1:-1]:
-            name = line[:20].strip()
-            _type = line[20:30].strip()
-            initial_value = line[30:40].strip()
-            if _type.upper() == "TIMER":
-                initial_status = line[40:50].strip()
-            else:
-                initial_status = (
-                    "n/a"  # unless the type is a timer, nothing else has an initial status
-                )
-            data_list.append(
-                [
-                    name,
-                    _type,
-                    initial_value,
-                    initial_status,
-                ]
-            )
-        self.data = pd.DataFrame(data_list, columns=header)
-
-    def _write(self):
-        var_block = [
-            "VARIABLES",
-        ]
-        rows = []
-        for _, name, _type, initial_value, initial_status in self.data.itertuples():
-            string = f"{name:<{20}}"
-            if _type.upper() == "TIMER":
-                string += join_10_char(_type, initial_value, initial_status)
-            else:
-                string += join_10_char(_type, initial_value)
-            rows.append(string)
-
-        var_block.extend(rows)
-        var_block.append("END VARIABLES")
-
-        return var_block
-
-    def _get_diff(self, other):
-        return self.__eq__(other, return_diff=True)
-
-    def __eq__(self, other, return_diff=False):
-        result = True
-        diff = []
-        result, diff = check_item_with_dataframe_equal(
-            self.__dict__, other.__dict__, name="Variables", diff=diff
-        )
-        return (result, diff) if return_diff else result
+"""
+Flood Modeller Python API
+Copyright (C) 2024 Jacobs U.K. Limited
+
+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/.
+
+If you have any query about this program or this License, please contact us at support@floodmodeller.com or write to the following
+address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
+"""
+
+import pandas as pd
+
+from ..diff import check_item_with_dataframe_equal
+from ..to_from_json import Jsonable
+from .helpers import join_10_char
+
+
+class Variables(Jsonable):
+    """Class to hold VARIABLES"""
+
+    def __init__(self, var_block):
+        self._read(var_block)
+
+    def __repr__(self):
+        return "<floodmodeller_api Variables Class: Variables()>"
+
+    def _read(self, var_block):
+        header = [
+            "name",
+            "type",
+            "initial value",
+            "initial status",
+        ]
+        data_list = []
+        for line in var_block[1:-1]:
+            name = line[:20].strip()
+            _type = line[20:30].strip()
+            initial_value = line[30:40].strip()
+            # unless the type is a timer, nothing else has an initial status
+            initial_status = line[40:50].strip() if _type.upper() == "TIMER" else "n/a"
+            data_list.append(
+                [
+                    name,
+                    _type,
+                    initial_value,
+                    initial_status,
+                ],
+            )
+        self.data = pd.DataFrame(data_list, columns=header)
+
+    def _write(self):
+        var_block = [
+            "VARIABLES",
+        ]
+        rows = []
+        for _, name, _type, initial_value, initial_status in self.data.itertuples():
+            string = f"{name:<{20}}"
+            if _type.upper() == "TIMER":
+                string += join_10_char(_type, initial_value, initial_status)
+            else:
+                string += join_10_char(_type, initial_value)
+            rows.append(string)
+
+        var_block.extend(rows)
+        var_block.append("END VARIABLES")
+
+        return var_block
+
+    def _get_diff(self, other):
+        return self.__eq__(other, return_diff=True)  # pylint: disable=unnecessary-dunder-call
+
+    def __eq__(self, other, return_diff=False):
+        result = True
+        diff = []
+        result, diff = check_item_with_dataframe_equal(
+            self.__dict__,
+            other.__dict__,
+            name="Variables",
+            diff=diff,
+        )
+        return (result, diff) if return_diff else result

floodmodeller_api/urban1d/__init__.py

@@ -1,11 +1,11 @@
-from .subsections import (
-    ALL_SUBSECTIONS,
-    CONDUITS,
-    JUNCTIONS,
-    LOSSES,
-    OUTFALLS,
-    RAINGAUGES,
-    SUPPORTED_SUBSECTIONS,
-    UNSUPPORTED_SUBSECTIONS,
-    XSECTIONS,
-)
+from .subsections import (
+    ALL_SUBSECTIONS,
+    CONDUITS,
+    JUNCTIONS,
+    LOSSES,
+    OUTFALLS,
+    RAINGAUGES,
+    SUPPORTED_SUBSECTIONS,
+    UNSUPPORTED_SUBSECTIONS,
+    XSECTIONS,
+)