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

floodmodeller_api/toolbox/__init__.py

@@ -1,5 +1,5 @@
-from .model_build import AddSiltation, StructureLog
-
-# from .visualisation import ...
-# from .model_review import ...
-# from .results_analysis import ...
+from .model_build import AddSiltation, StructureLog
+
+# from .visualisation import ...
+# from .model_review import ...
+# from .results_analysis import ...

floodmodeller_api/toolbox/example_tool.py

@@ -1,45 +1,45 @@
-# Import the FMTool and Parameter classes to define the tool and parameters
-from floodmodeller_api.tool import FMTool, Parameter
-
-
-# ------ Define function ----- #
-# This is the funciton that should be run by the tool.
-# In this case it is just a simple sum function but you can
-# substitute any function in here.
-def my_sum(a: float, b: float):
-    ab = a + b
-    print(ab)
-    return ab
-
-
-# ------ Create the Tool ------ #
-class SumTool(FMTool):
-    # Define the name (required):
-    name = "Sum tool"
-    # Add the tool description (required)
-    description = "A basic tool to add two numbers together"
-    # Add the parameters (one per function argument):
-    parameters = [
-        # Add parameters using the Parameter class
-        Parameter(
-            name="a",
-            dtype=float,
-            description="the first number",
-            help_text="",
-            required=True,
-        ),
-        Parameter(
-            name="b",
-            dtype=float,
-            description="the second number",
-            help_text="",
-            required=True,
-        ),
-    ]
-    # Add the function to run
-    tool_function = my_sum
-
-
-if __name__ == "__main__":
-    tool = SumTool()
-    tool.run_from_command_line()
+# Import the FMTool and Parameter classes to define the tool and parameters
+from floodmodeller_api.tool import FMTool, Parameter
+
+
+# ------ Define function ----- #
+# This is the funciton that should be run by the tool.
+# In this case it is just a simple sum function but you can
+# substitute any function in here.
+def my_sum(a: float, b: float):
+    ab = a + b
+    print(ab)
+    return ab
+
+
+# ------ Create the Tool ------ #
+class SumTool(FMTool):
+    # Define the name (required):
+    name = "Sum tool"
+    # Add the tool description (required)
+    description = "A basic tool to add two numbers together"
+    # Add the parameters (one per function argument):
+    parameters = [
+        # Add parameters using the Parameter class
+        Parameter(
+            name="a",
+            dtype=float,
+            description="the first number",
+            help_text="",
+            required=True,
+        ),
+        Parameter(
+            name="b",
+            dtype=float,
+            description="the second number",
+            help_text="",
+            required=True,
+        ),
+    ]
+    # Add the function to run
+    tool_function = my_sum
+
+
+if __name__ == "__main__":
+    tool = SumTool()
+    tool.run_from_command_line()

floodmodeller_api/toolbox/model_build/__init__.py

@@ -1,2 +1,2 @@
-from .add_siltation_definition import AddSiltation
-from .structure_log_definition import StructureLog
+from .add_siltation_definition import AddSiltation
+from .structure_log_definition import StructureLog

floodmodeller_api/toolbox/model_build/add_siltation_definition.py

@@ -1,94 +1,100 @@
-""" This function allows you to raise the minimum bed level 300mm across all sections in a DAT file (i.e siltation) """
-# Import modules
-from pathlib import Path
-
-from floodmodeller_api import DAT
-from floodmodeller_api.tool import FMTool, Parameter
-from floodmodeller_api.units import RIVER
-
-
-# Define the function
-def raise_section_bed_levels(dat_input: Path, dat_output: Path, siltation: float):
-    dat = DAT(dat_input)  # Initialise DAT class
-
-    for name, section in dat.sections.items():  # iterate through all river sections
-        if not isinstance(section, RIVER):
-            # Skip any non river type units (e.g. interpolates)
-            continue
-        df = section.data  # get section data
-        min_elevation = df["Y"].min()  # get minimum cross section elevation
-        raised_bed = min_elevation + siltation  # define new lowest bed level
-        df.loc[
-            df["Y"] < raised_bed, "Y"
-        ] = raised_bed  # Raise any levels lower than this to the new lowest level
-
-    dat.save(dat_output)  # save updates
-
-
-# Wrap the FMTool class
-class AddSiltation(FMTool):
-    """
-    This tool allows you to add a set amount of siltation to raise the minimum bed levels of all
-    river sections in a DAT file
-
-    Args:
-        dat_input (str): Path to the input DAT file
-        siltation (float): Amount of siltation to raise beds (in meters)
-        dat_output (str): Path to the output DAT file
-
-
-    **Usage**
-
-    To use this tool, you can either run it from the command line:
-
-    .. code::
-
-        fmapi-add_siltation --dat_input "<dat file path>" --siltation 0.3 --dat_output "<dat file output path>"
-
-    Or as a gui:
-
-    .. code::
-
-        fmapi-add_siltation gui
-
-    Or you can use it from your code:
-
-    .. code:: python
-
-        from floodmodeller_api.toolbox import AddSiltation
-
-        AddSiltation.run(
-            dat_input="path/to/dat.dat",
-            siltation=0.3,
-            dat_output="path/to/output_dat.dat",
-        )
-    """
-
-    name = "Add Siltation"
-    description = (
-        "Tool to add a set amount of siltation to raise bed levels of river sections in a DAT file"
-    )
-    parameters = [
-        Parameter(
-            name="dat_input",
-            dtype=str,
-            description="Path to input DAT file",
-            help_text="Path to input DAT file",
-            required=True,
-        ),
-        Parameter(
-            name="dat_output",
-            dtype=str,
-            description="Path to output DAT file",
-            help_text="Path to output DAT file",
-            required=True,
-        ),
-        Parameter(
-            name="siltation",
-            dtype=float,
-            description="Amount of siltation to raise beds (in meters)",
-            help_text="Amount of siltation to raise beds (in meters)",
-            required=True,
-        ),
-    ]
-    tool_function = raise_section_bed_levels
+""" This function allows you to raise the minimum bed level 300mm across all sections in a DAT file (i.e siltation) """
+
+# Import modules
+from pathlib import Path
+
+from floodmodeller_api import DAT
+from floodmodeller_api.tool import FMTool, Parameter
+from floodmodeller_api.units import RIVER
+
+
+# Define the function
+def raise_section_bed_levels(dat_input: Path, dat_output: Path, siltation: float):
+    dat = DAT(dat_input)  # Initialise DAT class
+
+    for _, section in dat.sections.items():  # iterate through all river sections
+        if not isinstance(section, RIVER):
+            # Skip any non river type units (e.g. interpolates)
+            continue
+        df = section.data  # get section data
+        min_elevation = df["Y"].min()  # get minimum cross section elevation
+        raised_bed = min_elevation + siltation  # define new lowest bed level
+        df.loc[
+            df["Y"] < raised_bed,
+            "Y",
+        ] = raised_bed  # Raise any levels lower than this to the new lowest level
+
+    dat.save(dat_output)  # save updates
+
+
+# Wrap the FMTool class
+class AddSiltation(FMTool):
+    """
+    This tool allows you to add a set amount of siltation to raise the minimum bed levels of all
+    river sections in a DAT file
+
+    Args:
+        dat_input (str): Path to the input DAT file
+        siltation (float): Amount of siltation to raise beds (in meters)
+        dat_output (str): Path to the output DAT file
+
+
+    **Usage**
+
+    To use this tool, you can either run it from the command line:
+
+    .. code::
+
+        fmapi-add_siltation --dat_input "<dat file path>" --siltation 0.3 --dat_output "<dat file output path>"
+
+    Or as a gui:
+
+    .. code::
+
+        fmapi-add_siltation gui
+
+    Or you can use it from your code:
+
+    .. code:: python
+
+        from floodmodeller_api.toolbox import AddSiltation
+
+        AddSiltation.run(
+            dat_input="path/to/dat.dat",
+            siltation=0.3,
+            dat_output="path/to/output_dat.dat",
+        )
+    """
+
+    name = "Add Siltation"
+    description = (
+        "Tool to add a set amount of siltation to raise bed levels of river sections in a DAT file"
+    )
+    parameters = [
+        Parameter(
+            name="dat_input",
+            dtype=str,
+            description="Path to input DAT file",
+            help_text="Path to input DAT file",
+            required=True,
+        ),
+        Parameter(
+            name="dat_output",
+            dtype=str,
+            description="Path to output DAT file",
+            help_text="Path to output DAT file",
+            required=True,
+        ),
+        Parameter(
+            name="siltation",
+            dtype=float,
+            description="Amount of siltation to raise beds (in meters)",
+            help_text="Amount of siltation to raise beds (in meters)",
+            required=True,
+        ),
+    ]
+    tool_function = raise_section_bed_levels
+
+
+def main():
+    AddSiltation().run_from_command_line()

floodmodeller_api/toolbox/model_build/structure_log/__init__.py

@@ -1 +1 @@
-from .structure_log import StructureLogBuilder
+from .structure_log import StructureLogBuilder