floodmodeller-api 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

floodmodeller_api/toolbox/model_build/structure_log_definition.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+from typing import ClassVar
+
 from floodmodeller_api.tool import FMTool, Parameter
 
 from .structure_log import StructureLogBuilder
@@ -50,7 +54,7 @@ class StructureLog(FMTool):
 
     name = "Structure Log"
     description = "Creates a structure log"
-    parameters = [
+    parameters: ClassVar[list[Parameter]] = [
         Parameter(
             name="input_path",
             dtype=str,

floodmodeller_api/units/_base.py

@@ -40,7 +40,11 @@ class Unit(Jsonable):
             self._create_from_blank(**kwargs)
 
     @property
-    def name(self):
+    def unit(self) -> str:
+        return self._unit
+
+    @property
+    def name(self) -> str | None:
         return self._name
 
     @name.setter
@@ -48,20 +52,21 @@ class Unit(Jsonable):
         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',
-                )
+                msg = f'Cannot set unit name to "{new_name}" as it contains one or more spaces'
+                raise Exception(msg)
             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
+            msg = f'Failed to set unit name to "{new_name}" due to error: {e}'
+            raise Exception(msg) from e
 
     @property
-    def subtype(self):
+    def subtype(self) -> str | None:
         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")
+        msg = "You cannot change the subtype of a unit once it has been instantiated"
+        raise ValueError(msg)
 
     def __repr__(self):
         if self._subtype is None:
@@ -71,9 +76,8 @@ class Unit(Jsonable):
         )
 
     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",
-        )
+        msg = f"Creating new {self._unit} units is not yet supported by floodmodeller_api, only existing units can be read"
+        raise NotImplementedError(msg)
 
     def __str__(self):
         return "\n".join(self._write())

floodmodeller_api/units/conveyance.py

@@ -72,11 +72,12 @@ def calculate_cross_section_conveyance(
             total_length = np.where(in_panel_and_section, length, 0).sum(axis=1)
             total_mannings = np.where(in_panel_and_section, mannings, 0).sum(axis=1)
 
-            conveyance += np.where(
-                total_length >= MINIMUM_PERIMETER_THRESHOLD,
-                total_area ** (5 / 3) * total_length ** (1 / 3) / (total_mannings * rpl_panel),
-                0,
-            )
+            with np.errstate(divide="ignore", invalid="ignore"):
+                conveyance += np.where(
+                    total_length >= MINIMUM_PERIMETER_THRESHOLD,
+                    total_area ** (5 / 3) * total_length ** (1 / 3) / (total_mannings * rpl_panel),
+                    0,
+                )
 
     return pd.Series(conveyance, index=water_levels)
 
@@ -116,9 +117,10 @@ def calculate_geometry(
     is_submerged_on_right = (h1 <= 0) & (h2 > 0)
     conditions = [is_submerged, is_submerged_on_left, is_submerged_on_right]
 
-    # needed for partially submerged sections
-    dx_left = dx * h1 / (h1 - h2)
-    dx_right = dx * h2 / (h2 - h1)
+    with np.errstate(divide="ignore", invalid="ignore"):
+        # needed for partially submerged sections
+        dx_left = dx * h1 / (h1 - h2)
+        dx_right = dx * h2 / (h2 - h1)
 
     area = np.select(
         conditions,

floodmodeller_api/units/helpers.py

@@ -116,8 +116,6 @@ def _to_data_list(block: list[str], num_cols: int | None = None, date_col: int |
         else:
             row_split = [_to_float(itm) for itm in row_split]
 
-        row_list = []
-        for var in row_split:
-            row_list.append(var)
+        row_list = list(row_split)
         data_list.append(row_list)
     return data_list

floodmodeller_api/units/losses.py

@@ -238,9 +238,8 @@ class BLOCKAGE(Unit):
 
         # Custom validation for blockage percentage
         if self.data.max() > 1 or self.data.min() < 0:
-            raise ValueError(
-                f"Parameter error with {repr(self)} - blockage percentage must be between 0 and 1",
-            )
+            msg = f"Parameter error with {self!r} - blockage percentage must be between 0 and 1"
+            raise ValueError(msg)
 
         header = f"BLOCKAGE #revision#{self._revision} {self.comment}"
         labels = join_n_char_ljust(

floodmodeller_api/units/sections.py

@@ -14,6 +14,10 @@ If you have any query about this program or this License, please contact us at s
 address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
 """
 
+from __future__ import annotations
+
+from typing import ClassVar
+
 import pandas as pd
 
 from floodmodeller_api.validation import _validate_unit
@@ -54,7 +58,7 @@ class RIVER(Unit):
     """
 
     _unit = "RIVER"
-    _required_columns = [
+    _required_columns: ClassVar[list[str]] = [
         "X",
         "Y",
         "Mannings n",
@@ -204,7 +208,7 @@ class RIVER(Unit):
             # Manual so slope can have more sf
             params = f'{self.dist_to_next:>10.3f}{"":>10}{self.slope:>10.6f}{self.density:>10.3f}'
             self.nrows = len(self._data)
-            riv_block = [header, self.subtype, labels, params, f"{str(self.nrows):>10}"]
+            riv_block = [header, self.subtype, labels, params, f"{self.nrows!s:>10}"]
 
             riv_data = []
             for (
@@ -257,11 +261,11 @@ class RIVER(Unit):
     @data.setter
     def data(self, new_df: pd.DataFrame) -> None:
         if not isinstance(new_df, pd.DataFrame):
-            raise ValueError(
-                "The updated data table for a cross section must be a pandas DataFrame.",
-            )
-        if new_df.columns != self._required_columns:
-            raise ValueError(f"The DataFrame must only contain columns: {self._required_columns}")
+            msg = "The updated data table for a cross section must be a pandas DataFrame."
+            raise ValueError(msg)
+        if list(map(str.lower, new_df.columns)) != list(map(str.lower, self._required_columns)):
+            msg = f"The DataFrame must only contain columns: {self._required_columns}"
+            raise ValueError(msg)
         self._data = new_df
 
     @property
@@ -325,11 +329,11 @@ class RIVER(Unit):
     @active_data.setter
     def active_data(self, new_df: pd.DataFrame) -> None:
         if not isinstance(new_df, pd.DataFrame):
-            raise ValueError(
-                "The updated data table for a cross section must be a pandas DataFrame.",
-            )
+            msg = "The updated data table for a cross section must be a pandas DataFrame."
+            raise ValueError(msg)
         if new_df.columns.to_list() != self._required_columns:
-            raise ValueError(f"The DataFrame must only contain columns: {self._required_columns}")
+            msg = f"The DataFrame must only contain columns: {self._required_columns}"
+            raise ValueError(msg)
 
         # Ensure activation markers are present
         new_df = new_df.copy()

floodmodeller_api/units/structures.py

@@ -376,7 +376,7 @@ class BRIDGE(Unit):
                 self.orifice_discharge_coefficient,
             )
             self.section_nrows = len(self.section_data)
-            br_block.extend(["MANNING", params, f"{str(self.section_nrows):>10}"])
+            br_block.extend(["MANNING", params, f"{self.section_nrows!s:>10}"])
 
             section_data = []
             for _, x, y, n, embankments in self.section_data.itertuples():
@@ -388,7 +388,7 @@ class BRIDGE(Unit):
             br_block.extend(section_data)
 
             self.opening_nrows = len(self.opening_data)
-            br_block.append(f"{str(self.opening_nrows):>10}")
+            br_block.append(f"{self.opening_nrows!s:>10}")
             opening_data = []
             for _, start, finish, spring, soffit in self.opening_data.itertuples():
                 row = join_10_char(start, finish, spring, soffit)
@@ -424,10 +424,10 @@ class BRIDGE(Unit):
                 [
                     "MANNING",
                     params,
-                    f"{str(self.abutment_type):>10}",
+                    f"{self.abutment_type!s:>10}",
                     pier_params,
                     self.abutment_alignment,
-                    f"{str(self.section_nrows):>10}",
+                    f"{self.section_nrows!s:>10}",
                 ],
             )
 
@@ -440,7 +440,7 @@ class BRIDGE(Unit):
             br_block.extend(section_data)
 
             self.opening_nrows = len(self.opening_data)
-            br_block.append(f"{str(self.opening_nrows):>10}")
+            br_block.append(f"{self.opening_nrows!s:>10}")
             opening_data = []
             for _, start, finish, spring, soffit in self.opening_data.itertuples():
                 row = join_10_char(start, finish, spring, soffit)
@@ -448,7 +448,7 @@ class BRIDGE(Unit):
             br_block.extend(opening_data)
 
             self.culvert_nrows = len(self.culvert_data)
-            br_block.append(f"{str(self.culvert_nrows):>10}")
+            br_block.append(f"{self.culvert_nrows!s:>10}")
             culvert_data = []
             for (
                 _,
@@ -481,7 +481,7 @@ class BRIDGE(Unit):
                     "YARNELL",
                     params,
                     additional_params,
-                    f"{str(self.us_section_nrows):>10}",
+                    f"{self.us_section_nrows!s:>10}",
                 ],
             )
 
@@ -495,7 +495,7 @@ class BRIDGE(Unit):
             br_block.extend(us_section_data)
 
             self.ds_section_nrows = len(self.ds_section_data)
-            br_block.append(f"{str(self.ds_section_nrows):>10}")
+            br_block.append(f"{self.ds_section_nrows!s:>10}")
             ds_section_data = []
             for _, x, y, n, embankments, top_level in self.ds_section_data.itertuples():
                 # Adding extra 10 spaces before embankment flag
@@ -506,7 +506,7 @@ class BRIDGE(Unit):
             br_block.extend(ds_section_data)
 
             self.pier_locs_nrows = len(self.pier_locs_data)
-            br_block.append(f"{str(self.pier_locs_nrows):>10}")
+            br_block.append(f"{self.pier_locs_nrows!s:>10}")
             pier_locs_data = []
             for (
                 _,

floodmodeller_api/units/units.py

@@ -14,6 +14,8 @@ If you have any query about this program or this License, please contact us at s
 address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
 """
 
+from __future__ import annotations
+
 from typing import TypedDict
 
 

floodmodeller_api/urban1d/_base.py

@@ -51,9 +51,8 @@ class UrbanUnit(Jsonable):
         return None
 
     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",
-        )
+        msg = f"Creating new {self._unit} units is not yet supported by floodmodeller_api, only existing units can be read"
+        raise NotImplementedError(msg)
 
     def __str__(self):
         return self._write()
@@ -110,9 +109,8 @@ class UrbanSubsection(Jsonable):
         return f"<floodmodeller_api UrbanSubsection Class: {self._attribute}>"
 
     def _create_from_blank(self):
-        raise NotImplementedError(
-            f"Creating new {self._name} subsections is not yet supported by floodmodeller_api, only existing subsections can be read",
-        )
+        msg = f"Creating new {self._name} subsections is not yet supported by floodmodeller_api, only existing subsections can be read"
+        raise NotImplementedError(msg)
 
     def __str__(self):
         return "\n".join(self._write())
@@ -155,9 +153,8 @@ class UrbanSubsection(Jsonable):
                 # Miss-match found
                 # check that it is not an existing label in units
                 if unit.name in units:
-                    raise Exception(
-                        f'Error: Cannot update label "{name}" to "{unit.name}" beacuase "{unit.name}" already exists in the {self._attribute} subsection',
-                    )
+                    msg = f'Error: Cannot update label "{name}" to "{unit.name}" beacuase "{unit.name}" already exists in the {self._attribute} subsection'
+                    raise Exception(msg)
 
                 units[unit.name] = unit
                 del units[name]

floodmodeller_api/urban1d/outfalls.py

@@ -102,7 +102,8 @@ class OUTFALL(UrbanUnit):
             params2 = join_n_char_ljust(15, self.tseries, self.gated, self.routeto)
 
         else:
-            raise RuntimeError(f"{self.type} not supported")
+            msg = f"{self.type} not supported"
+            raise RuntimeError(msg)
 
         return params1 + params2
 

floodmodeller_api/urban1d/raingauges.py

@@ -97,7 +97,8 @@ class RAINGAUGE(UrbanUnit):
             params2 = join_n_char_ljust(15, self.filename, self.station, self.units)
 
         else:
-            raise RuntimeError(f"{self.data_option} not supported")
+            msg = f"{self.data_option} not supported"
+            raise RuntimeError(msg)
 
         return params1 + params2
 

floodmodeller_api/urban1d/subsections.py

@@ -14,6 +14,8 @@ If you have any query about this program or this License, please contact us at s
 address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London, SE1 2QG, United Kingdom.
 """
 
+from __future__ import annotations
+
 from typing import Type, TypedDict
 
 from ._base import UrbanSubsection

floodmodeller_api/urban1d/xsections.py

@@ -31,7 +31,7 @@ class XSECTION(UrbanUnit):
         geom3 (float): auxiliary parameter (width, side slopes, etc.) as listed in Table D-1. (required, applicable to shape types)
         geom4 (float):auxiliary parameter (width, side slopes, etc.) as listed in Table D-1. (required, applicable to shape types)
         barrels (float): Barrels type  number of barrels (i.e., number of parallel pipes of equal size, slope, and roughness) associated with a conduit of shape type , or "CUSTOM" type (optional, default is 1).
-        culvert (int): Culvert code number from Table A.10 for the conduit’s inlet geometry if it is a culvert subject to possible inlet flow control.  Only an option for shape type (leave blank otherwise) (optional, default is "").
+        culvert (int): Culvert code number from Table A.10 for the conduit's inlet geometry if it is a culvert subject to possible inlet flow control.  Only an option for shape type (leave blank otherwise) (optional, default is "").
         curve (str): Curve name of a Shape Curve in the [CURVES] section that defines how width varies with depth. (optional, applicable to shape types only)
         tsect (str): Name of an entry in the [TRANSECTS] section that describes the cross-section geometry of an irregular channel. (required, applicable to "IREGUALAR types only)
 
@@ -109,7 +109,8 @@ class XSECTION(UrbanUnit):
             params2 = join_n_char_ljust(15, self.shape, self.tsect)
 
         else:
-            raise RuntimeError(f"{self.shape} not supported")
+            msg = f"{self.shape} not supported"
+            raise RuntimeError(msg)
 
         return params1 + params2
 

floodmodeller_api/util.py

@@ -58,7 +58,7 @@ def read_file(filepath: str | Path) -> FMFile:
 
 
     """
-    from . import DAT, IED, IEF, INP, LF1, LF2, XML2D, ZZN
+    from . import DAT, IED, IEF, INP, LF1, LF2, XML2D, ZZN, ZZX
     from .hydrology_plus import HydrologyPlusExport
 
     suffix_to_class = {
@@ -67,6 +67,7 @@ def read_file(filepath: str | Path) -> FMFile:
         ".ied": IED,
         ".xml": XML2D,
         ".zzn": ZZN,
+        ".zzx": ZZX,
         ".inp": INP,
         ".lf1": LF1,
         ".lf2": LF2,
@@ -77,13 +78,26 @@ def read_file(filepath: str | Path) -> FMFile:
     if api_class:
         return api_class(filepath)
 
-    raise ValueError(f"Unsupported file type: {filepath.suffix}")
+    msg = f"Unsupported file type: {filepath.suffix}"
+    raise ValueError(msg)
 
 
 def is_windows() -> bool:
     return sys.platform.startswith("win")
 
 
+def get_associated_file(original_file: Path, new_suffix: str) -> Path:
+    new_file = original_file.with_suffix(new_suffix)
+    if not new_file.exists():
+        msg = (
+            f"Error: Could not find associated {new_suffix} file."
+            f" Ensure that the {original_file.suffix} results"
+            f" have an associated {new_suffix} file with matching name."
+        )
+        raise FileNotFoundError(msg)
+    return new_file
+
+
 def handle_exception(when: str) -> Callable:
     """Decorator factory to wrap a method with exception handling."""
 

floodmodeller_api/validation/validation.py

@@ -41,7 +41,8 @@ def _validate_unit(unit, urban=False):
                 if not value[0]
             ],
         )
-        raise ValueError(f"One or more parameters in {repr(unit)} are invalid:\n     {errors}")
+        msg = f"One or more parameters in {unit!r} are invalid:\n     {errors}"
+        raise ValueError(msg)
 
 
 def _validate_parameter(param, value):  # noqa: C901, PLR0911, PLR0912

floodmodeller_api/version.py

@@ -1 +1 @@
-__version__ = "0.5.0"
+__version__ = "0.5.1"

floodmodeller_api/xml2d.py

@@ -17,7 +17,6 @@ address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London
 from __future__ import annotations
 
 import io
-import os
 import time
 from copy import deepcopy
 from pathlib import Path
@@ -205,12 +204,9 @@ class XML2D(FMFile):
 
     def _validate(self):
         try:
-            self._xsdschema.assert_(self._xmltree)
+            self._xsdschema.assert_(self._xmltree)  # noqa: PT009
         except AssertionError as err:
-            msg = (
-                f"XML Validation Error for {repr(self)}:\n"
-                f"     {err.args[0].replace(self._ns, '')}"
-            )
+            msg = f"XML Validation Error for {self!r}:\n     {err.args[0].replace(self._ns, '')}"
             raise ValueError(msg) from err
 
     def _recursive_update_xml(  # noqa: C901, PLR0912
@@ -224,7 +220,8 @@ class XML2D(FMFile):
 
         for key, item in new_dict.items():
             if key in self._multi_value_keys and not isinstance(item, list):
-                raise Exception(f"Element: '{key}' must be added as list")
+                msg = f"Element: '{key}' must be added as list"
+                raise Exception(msg)
             if parent_key == "ROOT":
                 parent = self._xmltree.getroot()
             else:
@@ -294,7 +291,8 @@ class XML2D(FMFile):
         from_list=False,
     ):
         if add_key in self._multi_value_keys and not isinstance(add_item, list) and not from_list:
-            raise Exception(f"Element: '{add_key}' must be added as list")
+            msg = f"Element: '{add_key}' must be added as list"
+            raise Exception(msg)
         if isinstance(add_item, dict):
             new_element = etree.SubElement(parent, f"{self._ns}{add_key}")
             for key, item in add_item.items():
@@ -509,12 +507,11 @@ class XML2D(FMFile):
         self.range_settings = range_settings if range_settings else {}
 
         if self._filepath is None:
-            raise UserWarning(
-                "xml2D must be saved to a specific filepath before simulate() can be called.",
-            )
+            msg = "xml2D must be saved to a specific filepath before simulate() can be called."
+            raise UserWarning(msg)
         if precision.upper() == "DEFAULT":
             precision = "SINGLE"  # defaults to single precision
-            for _, domain in self.domains.items():
+            for domain in self.domains.values():
                 if domain["run_data"].get("double_precision") == "required":
                     precision = "DOUBLE"
                     break
@@ -525,14 +522,13 @@ class XML2D(FMFile):
         else:
             _enginespath = enginespath
             if not Path(_enginespath).exists():
-                raise Exception(
-                    f"Flood Modeller non-default engine path not found! {str(_enginespath)}",
-                )
+                msg = f"Flood Modeller non-default engine path not found! {_enginespath!s}"
+                raise Exception(msg)
 
         # checking if all schemes used are fast, if so will use FAST.exe
         # TODO: Add in option to choose to use or not to use if you can
         is_fast = True
-        for _, domain in self.domains.items():
+        for domain in self.domains.values():
             if domain["run_data"]["scheme"] != "FAST":
                 is_fast = False
                 break
@@ -545,7 +541,8 @@ class XML2D(FMFile):
             isis2d_fp = str(Path(_enginespath, "ISIS2d_DP.exe"))
 
         if not Path(isis2d_fp).exists():
-            raise Exception(f"Flood Modeller engine not found! Expected location: {isis2d_fp}")
+            msg = f"Flood Modeller engine not found! Expected location: {isis2d_fp}"
+            raise Exception(msg)
 
         console_output = console_output.lower()
         run_command = (
@@ -556,7 +553,7 @@ class XML2D(FMFile):
         if method.upper() == "WAIT":
             print("Executing simulation ... ")
             # execute simulation
-            process = Popen(run_command, cwd=os.path.dirname(self._filepath), stdout=stdout)
+            process = Popen(run_command, cwd=Path(self._filepath).parent, stdout=stdout)
 
             # progress bar based on log files:
             if console_output == "simple":
@@ -573,7 +570,7 @@ class XML2D(FMFile):
         elif method.upper() == "RETURN_PROCESS":
             print("Executing simulation ...")
             # execute simulation
-            return Popen(run_command, cwd=os.path.dirname(self._filepath), stdout=stdout)
+            return Popen(run_command, cwd=Path(self._filepath).parent, stdout=stdout)
 
         return None
 
@@ -584,7 +581,8 @@ class XML2D(FMFile):
             floodmodeller_api.LF2 class object
         """
         if not self._log_path.exists():
-            raise FileNotFoundError("Log file (LF2) not found")
+            msg = "Log file (LF2) not found"
+            raise FileNotFoundError(msg)
 
         return LF2(self._log_path)