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

floodmodeller_api/urban1d/general_parameters.py

@@ -1,58 +1,58 @@
-"""
-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.
-"""
-
-DEFAULT_OPTIONS = {
-    "flow_units": None,
-    "infiltration": None,
-    "flow_routing": None,
-    "link_offsets": None,
-    "force_main_equation": None,
-    "ignore_rainfall": None,
-    "ignore_snowmelt": None,
-    "ignore_groundwater": None,
-    "ignore_rdii": None,
-    "ignore_routing": None,
-    "ignore_quality": None,
-    "allow_ponding": None,
-    "skip_steady_state": None,
-    "sys_flow_tol": None,
-    "lat_flow_tol": None,
-    "start_date": None,
-    "start_time": None,
-    "end_date": None,
-    "end_time": None,
-    "report_start_date": None,
-    "report_start_time": None,
-    "sweep_start": None,
-    "sweep_end": None,
-    "dry_days": None,
-    "report_step": None,
-    "wet_step": None,
-    "dry_step": None,
-    "routing_step": None,
-    "lengthening_step": None,
-    "variable_step": None,
-    "minimum_step": None,
-    "inertial_damping": None,
-    "normal_flow_limited": None,
-    "min_surfarea": None,
-    "min_slope": None,
-    "max_trials": None,
-    "head_tolerance": None,
-    "threads": None,
-    "tempdir": None,
-    "rule_step": None,
-}
+"""
+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.
+"""
+
+DEFAULT_OPTIONS = {
+    "flow_units": None,
+    "infiltration": None,
+    "flow_routing": None,
+    "link_offsets": None,
+    "force_main_equation": None,
+    "ignore_rainfall": None,
+    "ignore_snowmelt": None,
+    "ignore_groundwater": None,
+    "ignore_rdii": None,
+    "ignore_routing": None,
+    "ignore_quality": None,
+    "allow_ponding": None,
+    "skip_steady_state": None,
+    "sys_flow_tol": None,
+    "lat_flow_tol": None,
+    "start_date": None,
+    "start_time": None,
+    "end_date": None,
+    "end_time": None,
+    "report_start_date": None,
+    "report_start_time": None,
+    "sweep_start": None,
+    "sweep_end": None,
+    "dry_days": None,
+    "report_step": None,
+    "wet_step": None,
+    "dry_step": None,
+    "routing_step": None,
+    "lengthening_step": None,
+    "variable_step": None,
+    "minimum_step": None,
+    "inertial_damping": None,
+    "normal_flow_limited": None,
+    "min_surfarea": None,
+    "min_slope": None,
+    "max_trials": None,
+    "head_tolerance": None,
+    "threads": None,
+    "tempdir": None,
+    "rule_step": None,
+}

floodmodeller_api/urban1d/junctions.py

@@ -1,79 +1,81 @@
-"""
-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 floodmodeller_api.units.helpers import _to_float, join_n_char_ljust
-from floodmodeller_api.validation import _validate_unit
-
-from ._base import UrbanSubsection, UrbanUnit
-
-
-class JUNCTION(UrbanUnit):
-    """Class to hold and process JUNCTION unit type
-
-    Args:
-        name (str): Unit name
-        elevation (float): Elevation of junction invert (ft or m). (required)
-        max_depth (float): Depth from ground to invert elevation (ft or m) (default is 0). (optional)
-        initial_depth (float): Water depth at start of simulation (ft or m) (default is 0). (optional)
-        surface_depth (float): Maximum additional head above ground elevation that manhole junction can sustain under surcharge conditions (ft or m) (default is 0). (optional)
-        area_ponded (float): Area subjected to surface ponding once water depth exceeds Ymax (ft2 or m2) (default is 0) (optional).
-
-    Returns:
-        JUNCTION: Flood Modeller JUNCTION Unit class object
-    """
-
-    _unit = "JUNCTION"
-
-    def _read(self, line):
-        """Function to read a given JUNCTION line and store data as class attributes"""
-
-        # TODO: add functionality to read comments
-
-        unit_data = line.split()  # Get unit parameters
-
-        while len(unit_data) < 6:  # Extend length of unit_data if options variables not provided.
-            unit_data.append("")
-
-        self.name = str(unit_data[0])
-
-        self.elevation = _to_float(unit_data[1], 0.0)
-        self.max_depth = _to_float(unit_data[2], 0.0)
-        self.initial_depth = _to_float(unit_data[3], 0.0)
-        self.surface_depth = _to_float(unit_data[4], 0.0)
-        self.area_ponded = _to_float(unit_data[5], 0.0)
-
-    def _write(self):
-        """Function to write a valid JUNCTION line"""
-
-        _validate_unit(self, urban=True)
-
-        # TODO:Improve indentation format when writing and include header for completeness
-
-        return join_n_char_ljust(17, self.name) + join_n_char_ljust(
-            15,
-            self.elevation,
-            self.max_depth,
-            self.initial_depth,
-            self.surface_depth,
-            self.area_ponded,
-        )
-
-
-class JUNCTIONS(UrbanSubsection):
-    """Class to read/write the table of junctions"""
-
-    _urban_unit_class = JUNCTION
-    _attribute = "junctions"
+"""
+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 floodmodeller_api.units.helpers import _to_float, join_n_char_ljust
+from floodmodeller_api.validation import _validate_unit
+
+from ._base import UrbanSubsection, UrbanUnit
+
+
+class JUNCTION(UrbanUnit):
+    """Class to hold and process JUNCTION unit type
+
+    Args:
+        name (str): Unit name
+        elevation (float): Elevation of junction invert (ft or m). (required)
+        max_depth (float): Depth from ground to invert elevation (ft or m) (default is 0). (optional)
+        initial_depth (float): Water depth at start of simulation (ft or m) (default is 0). (optional)
+        surface_depth (float): Maximum additional head above ground elevation that manhole junction can sustain under surcharge conditions (ft or m) (default is 0). (optional)
+        area_ponded (float): Area subjected to surface ponding once water depth exceeds Ymax (ft2 or m2) (default is 0) (optional).
+
+    Returns:
+        JUNCTION: Flood Modeller JUNCTION Unit class object
+    """
+
+    _unit = "JUNCTION"
+    MIN_LENGTH = 6
+
+    def _read(self, line):
+        """Function to read a given JUNCTION line and store data as class attributes"""
+
+        # TODO: add functionality to read comments
+
+        unit_data = line.split()  # Get unit parameters
+
+        # Extend length of unit_data if options variables not provided.
+        while len(unit_data) < self.MIN_LENGTH:
+            unit_data.append("")
+
+        self.name = str(unit_data[0])
+
+        self.elevation = _to_float(unit_data[1], 0.0)
+        self.max_depth = _to_float(unit_data[2], 0.0)
+        self.initial_depth = _to_float(unit_data[3], 0.0)
+        self.surface_depth = _to_float(unit_data[4], 0.0)
+        self.area_ponded = _to_float(unit_data[5], 0.0)
+
+    def _write(self):
+        """Function to write a valid JUNCTION line"""
+
+        _validate_unit(self, urban=True)
+
+        # TODO:Improve indentation format when writing and include header for completeness
+
+        return join_n_char_ljust(17, self.name) + join_n_char_ljust(
+            15,
+            self.elevation,
+            self.max_depth,
+            self.initial_depth,
+            self.surface_depth,
+            self.area_ponded,
+        )
+
+
+class JUNCTIONS(UrbanSubsection):
+    """Class to read/write the table of junctions"""
+
+    _urban_unit_class = JUNCTION
+    _attribute = "junctions"

floodmodeller_api/urban1d/losses.py

@@ -1,74 +1,81 @@
-"""
-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 floodmodeller_api.units.helpers import _to_float, _to_str, join_n_char_ljust
-from floodmodeller_api.validation import _validate_unit
-
-from ._base import UrbanSubsection, UrbanUnit
-
-
-class LOSS(UrbanUnit):
-    """Class to hold and process LOSS unit type
-
-    Args:
-        name (str): Name of conduit. (required)
-        kentry (float): Entrance minor head loss coefficient. (required) # TODO: FM name - Entry Loss Coeff.
-        kexit (float): Exit minor head loss coefficient. (required) # TODO: FM name - Exit Loss Coeff.
-        kavg (float): Average minor head loss coefficient across lenght of culvert. (required) # TODO: FM name - Avg. Loss Coeff.
-        flap (str): YES/NO.  If conduit has a flat valve that prevents back flow. (optional, default NO ) # TODO: FM name - Flap Gate.
-        seepage (float): Rate of seepage loss into surrounding soil (in/hr or mm/hr). (optional, default is 0) # TODO: FM name - Seepage Loss Rate
-
-
-    Returns:
-        LOSS: Flood Modeller LOSS Unit class object
-    """
-
-    _unit = "LOSS"
-
-    def _read(self, line):
-        """Function to read a given LOSS line and store data as class attributes"""
-
-        # TODO: add functionality to read comments
-
-        unit_data = line.split()  # Get unit parameters
-
-        # Extend length of unit_data if options variables not provided.
-        while len(unit_data) < 6:
-            unit_data.append("")
-
-        self.name = _to_str(unit_data[0], "")
-        self.kentry = _to_float(unit_data[1], 0)
-        self.kexit = _to_float(unit_data[2], 0)
-        self.kavg = _to_float(unit_data[3], 0)
-        self.flap = _to_str(unit_data[4], "NO")
-        self.seepage = _to_float(unit_data[5], 0)
-
-    def _write(self):
-        """Function to write a valid LOSS line"""
-
-        _validate_unit(self, urban=True)
-
-        # TODO:Improve indentation format when writing and include header for completeness
-
-        return join_n_char_ljust(17, self.name) + join_n_char_ljust(
-            15, self.kentry, self.kexit, self.kavg, self.flap, self.seepage
-        )
-
-
-class LOSSES(UrbanSubsection):
-    """Class to read/write the table of losses"""
-
-    _urban_unit_class = LOSS
-    _attribute = "losses"
+"""
+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 floodmodeller_api.units.helpers import _to_float, _to_str, join_n_char_ljust
+from floodmodeller_api.validation import _validate_unit
+
+from ._base import UrbanSubsection, UrbanUnit
+
+
+class LOSS(UrbanUnit):
+    """Class to hold and process LOSS unit type
+
+    Args:
+        name (str): Name of conduit. (required)
+        kentry (float): Entrance minor head loss coefficient. (required) # TODO: FM name - Entry Loss Coeff.
+        kexit (float): Exit minor head loss coefficient. (required) # TODO: FM name - Exit Loss Coeff.
+        kavg (float): Average minor head loss coefficient across lenght of culvert. (required) # TODO: FM name - Avg. Loss Coeff.
+        flap (str): YES/NO.  If conduit has a flat valve that prevents back flow. (optional, default NO ) # TODO: FM name - Flap Gate.
+        seepage (float): Rate of seepage loss into surrounding soil (in/hr or mm/hr). (optional, default is 0) # TODO: FM name - Seepage Loss Rate
+
+
+    Returns:
+        LOSS: Flood Modeller LOSS Unit class object
+    """
+
+    _unit = "LOSS"
+    MIN_LENGTH = 6
+
+    def _read(self, line):
+        """Function to read a given LOSS line and store data as class attributes"""
+
+        # TODO: add functionality to read comments
+
+        unit_data = line.split()  # Get unit parameters
+
+        # Extend length of unit_data if options variables not provided.
+        while len(unit_data) < self.MIN_LENGTH:
+            unit_data.append("")
+
+        self.name = _to_str(unit_data[0], "")
+        self.kentry = _to_float(unit_data[1], 0)
+        self.kexit = _to_float(unit_data[2], 0)
+        self.kavg = _to_float(unit_data[3], 0)
+        self.flap = _to_str(unit_data[4], "NO")
+        self.seepage = _to_float(unit_data[5], 0)
+
+    def _write(self):
+        """Function to write a valid LOSS line"""
+
+        _validate_unit(self, urban=True)
+
+        # TODO:Improve indentation format when writing and include header for completeness
+
+        return join_n_char_ljust(17, self.name) + join_n_char_ljust(
+            15,
+            self.kentry,
+            self.kexit,
+            self.kavg,
+            self.flap,
+            self.seepage,
+        )
+
+
+class LOSSES(UrbanSubsection):
+    """Class to read/write the table of losses"""
+
+    _urban_unit_class = LOSS
+    _attribute = "losses"