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

floodmodeller_api/inp.py

@@ -1,266 +1,260 @@
-"""
-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 pathlib import Path
-from typing import Optional, Union
-
-from . import units
-from ._base import FMFile
-from .units.helpers import _to_str, join_n_char_ljust
-from .urban1d import subsections
-from .urban1d.general_parameters import DEFAULT_OPTIONS
-from .validation import _validate_unit
-
-
-class INP(FMFile):
-    """Reads and writes Flood Modeller 1DUrban file format '.inp'
-
-    Args:
-        inp_filepath (str, optional): Full filepath to inp file. If not specified, a new INP class will be created. Defaults to None.
-
-    Output:
-        Initiates 'INP' class object
-
-    Raises:
-        TypeError: Raised if inp_filepath does not point to a .inp file
-        FileNotFoundError: Raised if inp_filepath points to a file which does not exist
-    """
-
-    _filetype: str = "INP"
-    _suffix: str = ".inp"
-
-    def __init__(self, inp_filepath: Optional[Union[str, Path]] = None):
-        try:
-            if inp_filepath is not None:
-                FMFile.__init__(self, inp_filepath)
-                self._read()
-
-            else:
-                self._create_from_blank()
-
-            self._get_section_definitions()
-        except Exception as e:
-            self._handle_exception(e, when="read")
-
-    def _read(self):
-        # Read INP file
-        with open(self._filepath, "r") as inp_file:
-            self._raw_data = [line.rstrip("\n") for line in inp_file.readlines()]
-
-        # Generate INP file structure
-        self._update_inp_struct()
-
-    def _write(self) -> str:
-        """Returns string representation of the current INP data
-
-        Returns:
-            str: Full string representation of INP in its most recent state (including changes not yet saved to disk)
-        """
-        try:
-            _validate_unit(self, urban=True)
-
-            block_shift = 0  # Used to allow changes in the length of subsections.
-
-            for block in self._inp_struct:
-                if block["Subsection_Type"] in subsections.SUPPORTED_SUBSECTIONS:
-                    subsection_data = self._raw_data[
-                        block["start"] + block_shift : block["end"] + 1 + block_shift
-                    ]
-                    prev_block_len = len(subsection_data)
-
-                    if (
-                        subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"]
-                        == "general"
-                    ):
-                        # General parameters
-
-                        if block["Subsection_Type"] == "[OPTIONS]":
-                            # Options subsection
-
-                            new_subsection_data = [
-                                "[OPTIONS]",
-                                ";;Option             Value",
-                            ]
-
-                            for param, value in self.options.items():
-                                if value is not None:
-                                    option_line = join_n_char_ljust(21, param.upper(), value)
-                                    new_subsection_data.append(option_line)
-
-                            new_subsection_data.append("")  # blank line before next section
-
-                    else:  # Of unit type
-                        subsection = getattr(
-                            self,
-                            subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]][
-                                "attribute"
-                            ],
-                        )  # Get unit object
-                        new_subsection_data = (
-                            subsection._write()
-                        )  # String representation of unit object
-
-                    new_block_len = len(new_subsection_data)
-
-                    self._raw_data[
-                        block["start"] + block_shift : block["end"] + 1 + block_shift
-                    ] = new_subsection_data  # Replace existing subsection with new subsection string
-                    block_shift += (
-                        new_block_len - prev_block_len
-                    )  # adjust block shift for change in number of lines in block
-
-            # Regenerate INP file structure
-            self._update_inp_struct()
-
-            # Write _raw_data out to INP file.
-            inp_string = ""
-            for line in self._raw_data:
-                inp_string += line + "\n"
-
-            "\n".join(self._raw_data)
-
-            return inp_string
-
-        except Exception as e:
-            self._handle_exception(e, when="write")
-
-    def _create_from_blank(self):
-        raise NotImplementedError(
-            "Creating new 1D urban models (INP files) is not yet supported by floodmodeller_api, only existing models can be read"
-        )
-
-    def _get_section_definitions(self):
-        """Internal method used to get section definitions for each supported unit type and general parameters."""
-
-        # Loop through all blocks (subsections) within INP  and process if of a supported type.
-        for block in self._inp_struct:
-            if block["Subsection_Type"] in subsections.SUPPORTED_SUBSECTIONS:
-                raw_subsection_data = self._raw_data[
-                    block["start"] : block["end"] + 1
-                ]  # Raw data for subsection block of INP file
-
-                # Check if subsection type is 'general'
-                if (
-                    subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"]
-                    == "general"
-                ):
-                    if block["Subsection_Type"] == "[OPTIONS]":
-                        self.options = DEFAULT_OPTIONS.copy()
-                        for line in raw_subsection_data:
-                            if (
-                                line.upper() not in subsections.SUPPORTED_SUBSECTIONS
-                                and line.strip() != ""
-                                and not line.startswith(";")
-                            ):
-                                data = units.helpers.split_n_char(line, 21)
-
-                                # Set type to Float or Stirng, as appropirate.
-                                self.options[data[0].lower()] = _to_str(
-                                    data[1], None, check_float=True
-                                )
-
-                # Create appropriate sub-class instences for supported units
-                elif (
-                    subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"] == "units"
-                ):
-                    subsection_class = subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]][
-                        "class"
-                    ]
-
-                    subsection_attribute = subsections.SUPPORTED_SUBSECTIONS[
-                        block["Subsection_Type"]
-                    ]["attribute"]
-
-                    setattr(
-                        self,
-                        subsection_attribute,
-                        subsection_class(raw_subsection_data),
-                    )
-                    subsection = getattr(self, subsection_attribute)
-                    subsection_units = getattr(subsection, subsection._attribute)
-                    setattr(self, subsection._attribute, subsection_units)
-
-                # No action if subsection not supported. Leave block as raw data
-
-    def _update_inp_struct(self):
-        """Internal method used to update self._inp_struct which details the overall structure of the inp file as a list of blocks, each of which
-        are a dictionary containing the 'start', 'end' and 'type' of the block.
-
-        """
-        # Generate INP file structure
-        inp_struct = []
-        in_block = False
-        unit_block = {}
-        for idx, line in enumerate(self._raw_data):
-            # TODO: Add functionality to compare first four characters only (alphanumeric) - need to consider names shorter than 4 characters, and those with _ within name
-
-            # Check if subsection is known
-            if line.upper() in subsections.ALL_SUBSECTIONS:
-                if in_block is True:
-                    unit_block["end"] = idx - 1  # add ending index
-                    inp_struct.append(unit_block)  # append existing block bdy to the inp_struct
-                    unit_block = {}  # reset bdy block
-
-                unit_block["Subsection_Type"] = line.upper()
-                unit_block["start"] = idx
-                in_block = True
-
-        if len(unit_block) != 0:
-            # Only adds end block if there is a block present (i.e. an empty inp stays empty)
-            # add ending index for final block
-            unit_block["end"] = len(self._raw_data) - 1
-            inp_struct.append(unit_block)  # add final block
-
-        self._inp_struct = inp_struct
-
-    def diff(self, other: "INP", force_print: bool = False) -> None:
-        """Compares the INP class against another INP class to check whether they are
-        equivalent, or if not, what the differences are. Two instances of an INP class are
-        deemed equivalent if all of their attributes are equal except for the filepath and
-        raw data. For example, two INP files from different filepaths that had the same
-        data except maybe some differences in decimal places and some default parameters
-        ommitted, would be classed as equaivalent as they would produce the same INP instance
-        and write the exact same data.
-
-        The result is printed to the console. If you need to access the returned data, use
-        the method ``INP._get_diff()``
-
-        Args:
-            other (floodmodeller_api.INP): Other instance of an INP class
-            force_print (bool): Forces the API to print every difference found, rather than
-                just the first 25 differences. Defaults to False.
-        """
-        self._diff(other, force_print=force_print)
-
-    def update(self) -> None:
-        """Updates the existing INP based on any altered attributes"""
-
-        self._update()
-
-    def save(self, filepath: Union[str, Path]) -> None:
-        """Saves the INP to the given location, if pointing to an existing file it will be overwritten.
-        Once saved, the INP() class will continue working from the saved location, therefore any further calls to INP.update() will
-        update in the latest saved location rather than the original source INP used to construct the class
-
-        Args:
-            filepath (str): Filepath to new save location including the name and '.inp' extension
-
-        Raises:
-            TypeError: Raised if given filepath doesn't point to a file suffixed '.inp'
-
-        """
-
-        filepath = Path(filepath).absolute()
-        self._save(filepath)
+"""
+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
+
+from pathlib import Path
+
+from . import units
+from ._base import FMFile
+from .units.helpers import _to_str, join_n_char_ljust
+from .urban1d import subsections
+from .urban1d.general_parameters import DEFAULT_OPTIONS
+from .util import handle_exception
+from .validation import _validate_unit
+
+
+class INP(FMFile):
+    """Reads and writes Flood Modeller 1DUrban file format '.inp'
+
+    Args:
+        inp_filepath (str, optional): Full filepath to inp file. If not specified, a new INP class will be created. Defaults to None.
+
+    Output:
+        Initiates 'INP' class object
+
+    Raises:
+        TypeError: Raised if inp_filepath does not point to a .inp file
+        FileNotFoundError: Raised if inp_filepath points to a file which does not exist
+    """
+
+    _filetype: str = "INP"
+    _suffix: str = ".inp"
+
+    @handle_exception(when="read")
+    def __init__(self, inp_filepath: str | Path | None = None, from_json: bool = False):
+        if from_json:
+            return
+        if inp_filepath is not None:
+            FMFile.__init__(self, inp_filepath)
+            self._read()
+
+        else:
+            self._create_from_blank()
+
+        self._get_section_definitions()
+
+    def _read(self):
+        # Read INP file
+        with open(self._filepath) as inp_file:
+            self._raw_data = [line.rstrip("\n") for line in inp_file.readlines()]
+
+        # Generate INP file structure
+        self._update_inp_struct()
+
+    @handle_exception(when="write")
+    def _write(self) -> str:
+        """Returns string representation of the current INP data
+
+        Returns:
+            str: Full string representation of INP in its most recent state (including changes not yet saved to disk)
+        """
+        _validate_unit(self, urban=True)
+
+        block_shift = 0  # Used to allow changes in the length of subsections.
+
+        for block in self._inp_struct:
+            if block["Subsection_Type"] in subsections.SUPPORTED_SUBSECTIONS:
+                subsection_data = self._raw_data[
+                    block["start"] + block_shift : block["end"] + 1 + block_shift
+                ]
+                prev_block_len = len(subsection_data)
+
+                if (
+                    subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"]
+                    == "general"
+                ):
+                    # General parameters
+
+                    if block["Subsection_Type"] == "[OPTIONS]":
+                        # Options subsection
+
+                        new_subsection_data = [
+                            "[OPTIONS]",
+                            ";;Option             Value",
+                        ]
+
+                        for param, value in self.options.items():
+                            if value is not None:
+                                option_line = join_n_char_ljust(21, param.upper(), value)
+                                new_subsection_data.append(option_line)
+
+                        new_subsection_data.append("")  # blank line before next section
+
+                else:  # Of unit type
+                    subsection = getattr(
+                        self,
+                        subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["attribute"],
+                    )  # Get unit object
+                    new_subsection_data = (
+                        subsection._write()
+                    )  # String representation of unit object
+
+                new_block_len = len(new_subsection_data)
+
+                self._raw_data[block["start"] + block_shift : block["end"] + 1 + block_shift] = (
+                    new_subsection_data  # Replace existing subsection with new subsection string
+                )
+                block_shift += (
+                    new_block_len - prev_block_len
+                )  # adjust block shift for change in number of lines in block
+
+        # Regenerate INP file structure
+        self._update_inp_struct()
+
+        # Write _raw_data out to INP file.
+        return "\n".join(self._raw_data) + "\n"
+
+    def _create_from_blank(self):
+        raise NotImplementedError(
+            "Creating new 1D urban models (INP files) is not yet supported by floodmodeller_api, only existing models can be read",
+        )
+
+    def _get_section_definitions(self):
+        """Internal method used to get section definitions for each supported unit type and general parameters."""
+
+        # Loop through all blocks (subsections) within INP  and process if of a supported type.
+        for block in self._inp_struct:
+            if block["Subsection_Type"] in subsections.SUPPORTED_SUBSECTIONS:
+                raw_subsection_data = self._raw_data[
+                    block["start"] : block["end"] + 1
+                ]  # Raw data for subsection block of INP file
+
+                # Check if subsection type is 'general'
+                if (
+                    subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"]
+                    == "general"
+                ):
+                    if block["Subsection_Type"] == "[OPTIONS]":
+                        self.options = DEFAULT_OPTIONS.copy()
+                        for line in raw_subsection_data:
+                            if (
+                                line.upper() not in subsections.SUPPORTED_SUBSECTIONS
+                                and line.strip() != ""
+                                and not line.startswith(";")
+                            ):
+                                data = units.helpers.split_n_char(line, 21)
+
+                                # Set type to Float or Stirng, as appropirate.
+                                self.options[data[0].lower()] = _to_str(
+                                    data[1],
+                                    None,
+                                    check_float=True,
+                                )
+
+                # Create appropriate sub-class instences for supported units
+                elif (
+                    subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]]["group"] == "units"
+                ):
+                    subsection_class = subsections.SUPPORTED_SUBSECTIONS[block["Subsection_Type"]][
+                        "class"
+                    ]
+
+                    subsection_attribute = subsections.SUPPORTED_SUBSECTIONS[
+                        block["Subsection_Type"]
+                    ]["attribute"]
+
+                    setattr(
+                        self,
+                        subsection_attribute,
+                        subsection_class(raw_subsection_data),
+                    )
+                    subsection = getattr(self, subsection_attribute)
+                    subsection_units = getattr(subsection, subsection._attribute)
+                    setattr(self, subsection._attribute, subsection_units)
+
+                # No action if subsection not supported. Leave block as raw data
+
+    def _update_inp_struct(self):
+        """Internal method used to update self._inp_struct which details the overall structure of the inp file as a list of blocks, each of which
+        are a dictionary containing the 'start', 'end' and 'type' of the block.
+
+        """
+        # Generate INP file structure
+        inp_struct = []
+        in_block = False
+        unit_block = {}
+        for idx, line in enumerate(self._raw_data):
+            # TODO: Add functionality to compare first four characters only (alphanumeric) - need to consider names shorter than 4 characters, and those with _ within name
+
+            # Check if subsection is known
+            if line.upper() in subsections.ALL_SUBSECTIONS:
+                if in_block is True:
+                    unit_block["end"] = idx - 1  # add ending index
+                    inp_struct.append(unit_block)  # append existing block bdy to the inp_struct
+                    unit_block = {}  # reset bdy block
+
+                unit_block["Subsection_Type"] = line.upper()
+                unit_block["start"] = idx
+                in_block = True
+
+        if len(unit_block) != 0:
+            # Only adds end block if there is a block present (i.e. an empty inp stays empty)
+            # add ending index for final block
+            unit_block["end"] = len(self._raw_data) - 1
+            inp_struct.append(unit_block)  # add final block
+
+        self._inp_struct = inp_struct
+
+    def diff(self, other: INP, force_print: bool = False) -> None:
+        """Compares the INP class against another INP class to check whether they are
+        equivalent, or if not, what the differences are. Two instances of an INP class are
+        deemed equivalent if all of their attributes are equal except for the filepath and
+        raw data. For example, two INP files from different filepaths that had the same
+        data except maybe some differences in decimal places and some default parameters
+        ommitted, would be classed as equaivalent as they would produce the same INP instance
+        and write the exact same data.
+
+        The result is printed to the console. If you need to access the returned data, use
+        the method ``INP._get_diff()``
+
+        Args:
+            other (floodmodeller_api.INP): Other instance of an INP class
+            force_print (bool): Forces the API to print every difference found, rather than
+                just the first 25 differences. Defaults to False.
+        """
+        self._diff(other, force_print=force_print)
+
+    def update(self) -> None:
+        """Updates the existing INP based on any altered attributes"""
+
+        self._update()
+
+    def save(self, filepath: str | Path) -> None:
+        """Saves the INP to the given location, if pointing to an existing file it will be overwritten.
+        Once saved, the INP() class will continue working from the saved location, therefore any further calls to INP.update() will
+        update in the latest saved location rather than the original source INP used to construct the class
+
+        Args:
+            filepath (str): Filepath to new save location including the name and '.inp' extension
+
+        Raises:
+            TypeError: Raised if given filepath doesn't point to a file suffixed '.inp'
+
+        """
+
+        filepath = Path(filepath).absolute()
+        self._save(filepath)

floodmodeller_api/logs/__init__.py

@@ -1,2 +1,2 @@
-from .lf import LF1, LF2, lf_factory
-from .lf_params import error_2d_dict
+from .lf import LF1, LF2, create_lf
+from .lf_params import error_2d_dict