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

floodmodeller_api/toolbox/model_build/structure_log_definition.py

@@ -1,76 +1,76 @@
-from floodmodeller_api.tool import FMTool, Parameter
-
-from .structure_log import StructureLogBuilder
-
-
-class StructureLog(FMTool):
-    """
-    This tool creates an output log (.csv file) of all the conduits and structures within a DAT file.
-    It lists:
-
-    - Unit Name
-    - Unit Type
-    - Unit Subtype
-    - Comment
-    - Friction
-    - Distance (m)
-    - Weir Coefficient
-    - Culvert Inlet/Outlet Loss
-
-    Args:
-        input_path (str): Path to the input DAT file
-        output_path (str): Path to the output csv file
-
-
-    **Usage**
-
-    To use this tool, you can either run it from the command line:
-
-    .. code::
-
-        fmapi-structure_log --input_path "<dat file path>" --output_path "<give a file path to a csv>"
-
-    Or as a gui:
-
-    .. code::
-
-        fmapi-structure_log gui
-
-    Or you can use it from your code:
-
-    .. code:: python
-
-        from floodmodeller_api.toolbox import StructureLog
-
-        StructureLog.run(
-            input_path="path/to/dat.dat",
-            output_path="path/to/csv.csv",
-        )
-    """
-
-    name = "Structure Log"
-    description = "Creates a structure log"
-    parameters = [
-        Parameter(
-            name="input_path",
-            dtype=str,
-            description="Path to input DAT file",
-            help_text="Where the DAT file will be read from",
-            required=True,
-        ),
-        Parameter(
-            name="output_path",
-            dtype=str,
-            description="Path to output csv",
-            help_text="Where the new model will be saved (csv must be closed)",
-            required=True,
-        ),
-    ]
-
-    @classmethod
-    def tool_function(cls, **kwargs):
-        return StructureLogBuilder(**kwargs).create()
-
-
-def main():
-    StructureLog().run_from_command_line()
+from floodmodeller_api.tool import FMTool, Parameter
+
+from .structure_log import StructureLogBuilder
+
+
+class StructureLog(FMTool):
+    """
+    This tool creates an output log (.csv file) of all the conduits and structures within a DAT file.
+    It lists:
+
+    - Unit Name
+    - Unit Type
+    - Unit Subtype
+    - Comment
+    - Friction
+    - Distance (m)
+    - Weir Coefficient
+    - Culvert Inlet/Outlet Loss
+
+    Args:
+        input_path (str): Path to the input DAT file
+        output_path (str): Path to the output csv file
+
+
+    **Usage**
+
+    To use this tool, you can either run it from the command line:
+
+    .. code::
+
+        fmapi-structure_log --input_path "<dat file path>" --output_path "<give a file path to a csv>"
+
+    Or as a gui:
+
+    .. code::
+
+        fmapi-structure_log gui
+
+    Or you can use it from your code:
+
+    .. code:: python
+
+        from floodmodeller_api.toolbox import StructureLog
+
+        StructureLog.run(
+            input_path="path/to/dat.dat",
+            output_path="path/to/csv.csv",
+        )
+    """
+
+    name = "Structure Log"
+    description = "Creates a structure log"
+    parameters = [
+        Parameter(
+            name="input_path",
+            dtype=str,
+            description="Path to input DAT file",
+            help_text="Where the DAT file will be read from",
+            required=True,
+        ),
+        Parameter(
+            name="output_path",
+            dtype=str,
+            description="Path to output csv",
+            help_text="Where the new model will be saved (csv must be closed)",
+            required=True,
+        ),
+    ]
+
+    @classmethod
+    def tool_function(cls, **kwargs):
+        return StructureLogBuilder(**kwargs).create()
+
+
+def main():
+    StructureLog().run_from_command_line()

floodmodeller_api/units/__init__.py

@@ -1,10 +1,10 @@
-from .boundaries import HTBDY, QHBDY, QTBDY, REFHBDY
-from .comment import COMMENT
-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 .units import ALL_UNIT_TYPES, SUPPORTED_UNIT_TYPES, UNSUPPORTED_UNIT_TYPES
-from .unsupported import UNSUPPORTED
-from .variables import Variables
+from .boundaries import HTBDY, QHBDY, QTBDY, REFHBDY
+from .comment import COMMENT
+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 .units import ALL_UNIT_TYPES, SUPPORTED_UNIT_TYPES, UNSUPPORTED_UNIT_TYPES
+from .unsupported import UNSUPPORTED
+from .variables import Variables

floodmodeller_api/units/_base.py

@@ -1,212 +1,214 @@
-"""
-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.
-"""
-
-""" Holds the base unit class for all FM Units """
-
-from typing import List, Optional
-
-import pandas as pd
-
-from ..diff import check_item_with_dataframe_equal
-from .helpers import _to_float, _to_str, join_10_char, join_n_char_ljust, split_10_char
-
-
-class Unit:
-    _unit: Optional[str] = None
-    _subtype: Optional[str] = None
-    _name: Optional[str] = None
-
-    def __init__(self, unit_block=None, n=12, **kwargs):
-        self._label_len = n
-        if unit_block is not None:
-            self._read(unit_block, **kwargs)
-        else:
-            self._create_from_blank(**kwargs)
-
-    @property
-    def name(self):
-        return self._name
-
-    @name.setter
-    def name(self, new_name):
-        try:
-            new_name = str(new_name)
-            if " " in new_name:
-                raise Exception(
-                    f'Cannot set unit name to "{new_name}" as it contains one or more spaces'
-                )
-            self._name = new_name
-        except Exception as e:
-            raise Exception(f'Failed to set unit name to "{new_name}" due to error: {e}') from e
-
-    @property
-    def subtype(self):
-        return self._subtype
-
-    @subtype.setter
-    def subtype(self, new_value):
-        raise ValueError("You cannot change the subtype of a unit once it has been instantiated")
-
-    def __repr__(self):
-        if self._subtype is None:
-            return f"<floodmodeller_api Unit Class: {self._unit}(name={self._name})>"
-        return (
-            f"<floodmodeller_api Unit Class: {self._unit}(name={self._name}, type={self._subtype})>"
-        )
-
-    def _create_from_blank(self):
-        raise NotImplementedError(
-            f"Creating new {self._unit} units is not yet supported by floodmodeller_api, only existing units can be read"
-        )
-
-    def __str__(self):
-        return "\n".join(self._write())
-
-    def _read(self, block: List[str]):
-        raise NotImplementedError
-
-    def _write(self):
-        raise NotImplementedError
-
-    def _diff(self, other):
-        diff = self._get_diff(other)
-        if diff[0]:
-            print("No difference, units are equivalent")
-        else:
-            print("\n".join([f"{name}:  {reason}" for name, reason in diff[1]]))
-
-    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=f"{self._unit}.{self._subtype or ''}.{self._name}",
-            diff=diff,
-        )
-        return (result, diff) if return_diff else result
-
-    # rules & varrules
-
-    def _read_rules(self, block):
-        rule_params = split_10_char(block[self._last_gate_row + 1])
-        self.nrules = int(rule_params[0])
-        self.rule_sample_time = _to_float(rule_params[1])
-        self.timeunit = _to_str(rule_params[2], "SECONDS", check_float=False)
-        self.extendmethod = _to_str(rule_params[3], "EXTEND")
-        self.rules = self._get_logical_rules(self.nrules, block, self._last_gate_row + 2)
-        # Get time rule data set
-        nrows = int(split_10_char(block[self._last_rule_row + 1])[0])
-        data_list = []
-        for row in block[self._last_rule_row + 2 : self._last_rule_row + 2 + nrows]:
-            row_split = split_10_char(f"{row:<20}")
-            x = _to_float(row_split[0])  # time
-            y = row[10:].strip()  # operating rules
-            data_list.append([x, y])
-        self._last_time_row = self._last_rule_row + nrows + 1
-        rule_data = pd.DataFrame(data_list, columns=["Time", "Operating Rules"])
-        rule_data = rule_data.set_index("Time")
-        rule_data = rule_data["Operating Rules"]
-        self.time_rule_data = rule_data
-        # VARRULES (not always necessary)
-        self.has_varrules = False
-        if self._last_time_row + 1 < len(block):
-            if block[self._last_time_row + 1].strip() == "VARRULES":
-                self.has_varrules = True
-                varrule_params = split_10_char(block[self._last_time_row + 2])
-                self.nvarrules = int(varrule_params[0])
-                self.varrule_sample_time = _to_float(rule_params[1])
-                self.varrules = self._get_logical_rules(
-                    self.nvarrules, block, self._last_time_row + 3
-                )
-                # Get time rule data set
-                var_nrows = int(split_10_char(block[self._last_rule_row + 1])[0])
-                data_list = []
-                for row in block[self._last_rule_row + 2 : self._last_rule_row + 2 + var_nrows]:
-                    row_split = split_10_char(f"{row:<20}")
-                    x = _to_float(row_split[0])  # time
-                    y = row[10:].strip()  # operating rules
-                    data_list.append([x, y])
-
-                varrule_data = pd.DataFrame(data_list, columns=["Time", "Operating Rules"])
-                varrule_data = varrule_data.set_index("Time")
-                varrule_data = varrule_data["Operating Rules"]
-                self.time_varrule_data = varrule_data
-
-    def _write_rules(self, block):
-        # ADD RULES
-        block.append("RULES")
-        self.nrules = len(self.rules)
-        block.append(
-            f"{join_n_char_ljust(10, self.nrules)}{join_10_char(self.rule_sample_time)}{join_n_char_ljust(10, self.timeunit, self.extendmethod)}"
-        )
-        for rule in self.rules:
-            block.append(rule["name"])
-            block.extend(rule["logic"].split("\n"))
-
-        # ADD TIME RULE DATA SET
-        block.append("TIME RULE DATA SET")
-        block.append(join_10_char(len(self.time_rule_data)))
-        time_rule_data = [f"{join_10_char(t)}{o_r:<10}" for t, o_r in self.time_rule_data.items()]
-        block.extend(time_rule_data)
-
-        # ADD VARRULES (IF THEY ARE THERE)
-        if self.has_varrules:
-            block.append("VARRULES")
-            self.nvarrules = len(self.varrules)
-            block.append(
-                f"{join_n_char_ljust(10, self.nvarrules)}{join_10_char(self.varrule_sample_time)}{join_n_char_ljust(10, self.timeunit, self.extendmethod)}"
-            )
-            for varrule in self.varrules:
-                block.append(varrule["name"])
-                block.extend(varrule["logic"].split("\n"))
-
-            # ADD TIME VARRULE DATA SET
-            block.append("TIME RULE DATA SET")
-            block.append(join_10_char(len(self.time_varrule_data)))
-            time_varrule_data = [
-                f"{join_10_char(t)}{o_r:<10}" for t, o_r in self.time_rule_data.items()
-            ]
-            block.extend(time_varrule_data)
-
-        return block
-
-    def _get_logical_rules(self, nrules, block, rule_row):
-        rules = []
-        rules_recorded = 0
-        rule_logic = []
-        rule_dict = {}
-        nl = "\n"
-        while rules_recorded < nrules:
-            if block[rule_row].strip().upper().endswith(("END", "ENDIF")):
-                rule_logic.append(block[rule_row])
-                rule_dict["logic"] = f"{nl.join(rule_logic)}"
-                rules.append(rule_dict)
-                rule_logic = []
-                rule_dict = {}
-                rules_recorded += 1
-            elif len(rule_dict) == 0:
-                rule_dict = {"name": block[rule_row].strip()}
-            else:
-                rule_logic.append(block[rule_row])
-            rule_row += 1
-
-        self._last_rule_row = rule_row
-
-        return rules
+"""
+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 __future__ import annotations
+
+""" Holds the base unit class for all FM Units """
+
+import pandas as pd
+
+from ..diff import check_item_with_dataframe_equal
+from ..to_from_json import Jsonable
+from .helpers import _to_float, _to_str, join_10_char, join_n_char_ljust, split_10_char
+
+
+class Unit(Jsonable):
+    _unit: str
+    _subtype: str | None = None
+    _name: str | None = None
+
+    def __init__(self, unit_block=None, n=12, from_json: bool = False, **kwargs):
+        if from_json:
+            return
+        self._label_len = n
+        if unit_block is not None:
+            self._read(unit_block, **kwargs)
+        else:
+            self._create_from_blank(**kwargs)
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, new_name):
+        try:
+            new_name = str(new_name)
+            if " " in new_name:
+                raise Exception(
+                    f'Cannot set unit name to "{new_name}" as it contains one or more spaces',
+                )
+            self._name = new_name
+        except Exception as e:
+            raise Exception(f'Failed to set unit name to "{new_name}" due to error: {e}') from e
+
+    @property
+    def subtype(self):
+        return self._subtype
+
+    @subtype.setter
+    def subtype(self, new_value):
+        raise ValueError("You cannot change the subtype of a unit once it has been instantiated")
+
+    def __repr__(self):
+        if self._subtype is None:
+            return f"<floodmodeller_api Unit Class: {self._unit}(name={self._name})>"
+        return (
+            f"<floodmodeller_api Unit Class: {self._unit}(name={self._name}, type={self._subtype})>"
+        )
+
+    def _create_from_blank(self):
+        raise NotImplementedError(
+            f"Creating new {self._unit} units is not yet supported by floodmodeller_api, only existing units can be read",
+        )
+
+    def __str__(self):
+        return "\n".join(self._write())
+
+    def _read(self, block: list[str]):
+        raise NotImplementedError
+
+    def _write(self):
+        raise NotImplementedError
+
+    def _diff(self, other):
+        diff = self._get_diff(other)
+        if diff[0]:
+            print("No difference, units are equivalent")
+        else:
+            print("\n".join([f"{name}:  {reason}" for name, reason in diff[1]]))
+
+    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=f"{self._unit}.{self._subtype or ''}.{self._name}",
+            diff=diff,
+        )
+        return (result, diff) if return_diff else result
+
+    # rules & varrules
+
+    def _read_rules(self, block):
+        rule_params = split_10_char(block[self._last_gate_row + 1])
+        self.nrules = int(rule_params[0])
+        self.rule_sample_time = _to_float(rule_params[1])
+        self.timeunit = _to_str(rule_params[2], "SECONDS", check_float=False)
+        self.extendmethod = _to_str(rule_params[3], "EXTEND")
+        self.rules = self._get_logical_rules(self.nrules, block, self._last_gate_row + 2)
+        # Get time rule data set
+        nrows = int(split_10_char(block[self._last_rule_row + 1])[0])
+        data_list = []
+        for row in block[self._last_rule_row + 2 : self._last_rule_row + 2 + nrows]:
+            row_split = split_10_char(f"{row:<20}")
+            x = _to_float(row_split[0])  # time
+            y = row[10:].strip()  # operating rules
+            data_list.append([x, y])
+        self._last_time_row = self._last_rule_row + nrows + 1
+        rule_data = pd.DataFrame(data_list, columns=["Time", "Operating Rules"])
+        rule_data = rule_data.set_index("Time")
+        rule_data = rule_data["Operating Rules"]
+        self.time_rule_data = rule_data
+        # VARRULES (not always necessary)
+        self.has_varrules = False
+        if (self._last_time_row + 1 < len(block)) and (
+            block[self._last_time_row + 1].strip() == "VARRULES"
+        ):
+            self.has_varrules = True
+            varrule_params = split_10_char(block[self._last_time_row + 2])
+            self.nvarrules = int(varrule_params[0])
+            self.varrule_sample_time = _to_float(rule_params[1])
+            self.varrules = self._get_logical_rules(self.nvarrules, block, self._last_time_row + 3)
+            # Get time rule data set
+            var_nrows = int(split_10_char(block[self._last_rule_row + 1])[0])
+            data_list = []
+            for row in block[self._last_rule_row + 2 : self._last_rule_row + 2 + var_nrows]:
+                row_split = split_10_char(f"{row:<20}")
+                x = _to_float(row_split[0])  # time
+                y = row[10:].strip()  # operating rules
+                data_list.append([x, y])
+
+            varrule_data = pd.DataFrame(data_list, columns=["Time", "Operating Rules"])
+            varrule_data = varrule_data.set_index("Time")
+            varrule_data = varrule_data["Operating Rules"]
+            self.time_varrule_data = varrule_data
+
+    def _write_rules(self, block):
+        # ADD RULES
+        block.append("RULES")
+        self.nrules = len(self.rules)
+        block.append(
+            f"{join_n_char_ljust(10, self.nrules)}{join_10_char(self.rule_sample_time)}{join_n_char_ljust(10, self.timeunit, self.extendmethod)}",
+        )
+        for rule in self.rules:
+            block.append(rule["name"])
+            block.extend(rule["logic"].split("\n"))
+
+        # ADD TIME RULE DATA SET
+        block.append("TIME RULE DATA SET")
+        block.append(join_10_char(len(self.time_rule_data)))
+        time_rule_data = [f"{join_10_char(t)}{o_r:<10}" for t, o_r in self.time_rule_data.items()]
+        block.extend(time_rule_data)
+
+        # ADD VARRULES (IF THEY ARE THERE)
+        if self.has_varrules:
+            block.append("VARRULES")
+            self.nvarrules = len(self.varrules)
+            block.append(
+                f"{join_n_char_ljust(10, self.nvarrules)}{join_10_char(self.varrule_sample_time)}{join_n_char_ljust(10, self.timeunit, self.extendmethod)}",
+            )
+            for varrule in self.varrules:
+                block.append(varrule["name"])
+                block.extend(varrule["logic"].split("\n"))
+
+            # ADD TIME VARRULE DATA SET
+            block.append("TIME RULE DATA SET")
+            block.append(join_10_char(len(self.time_varrule_data)))
+            time_varrule_data = [
+                f"{join_10_char(t)}{o_r:<10}" for t, o_r in self.time_rule_data.items()
+            ]
+            block.extend(time_varrule_data)
+
+        return block
+
+    def _get_logical_rules(self, nrules, block, rule_row):
+        rules = []
+        rules_recorded = 0
+        rule_logic = []
+        rule_dict = {}
+        nl = "\n"
+        while rules_recorded < nrules:
+            if block[rule_row].strip().upper().endswith(("END", "ENDIF")):
+                rule_logic.append(block[rule_row])
+                rule_dict["logic"] = f"{nl.join(rule_logic)}"
+                rules.append(rule_dict)
+                rule_logic = []
+                rule_dict = {}
+                rules_recorded += 1
+            elif len(rule_dict) == 0:
+                rule_dict = {"name": block[rule_row].strip()}
+            else:
+                rule_logic.append(block[rule_row])
+            rule_row += 1
+
+        self._last_rule_row = rule_row
+
+        return rules