List of API Tools

StructureLog

class floodmodeller_api.toolbox.StructureLog

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

Parameters:

• 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:

fmapi-structure_log --input_path "<dat file path>" --output_path "<give a file path to a csv>"

Or as a gui:

fmapi-structure_log gui

Or you can use it from your code:

from floodmodeller_api.toolbox import StructureLog

StructureLog.run(
    input_path="path/to/dat.dat",
    output_path="path/to/csv.csv",
)

AddSiltation

class floodmodeller_api.toolbox.AddSiltation

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

Parameters:

• 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:

fmapi-add_siltation --dat_input "<dat file path>" --siltation 0.3 --dat_output "<dat file output path>"

Or as a gui:

fmapi-add_siltation gui

Or you can use it from your code:

from floodmodeller_api.toolbox import AddSiltation

AddSiltation.run(
    dat_input="path/to/dat.dat",
    siltation=0.3,
    dat_output="path/to/output_dat.dat",
)