top of page

Unlock new ways of working with Flood Modeller's API

The new Flood Modeller API, developed using Python code, opens new ways of working by allowing you to integrate your own custom tools and workflows directly with the Flood Modeller software. This added flexibility allows you to significantly boost your productivity and deliver innovative solutions to your clients by automating different tasks.

Coming in early 2022, the new Flood Modeller API will provide various benefits, including the ability to undertake global edits, analyse results even faster and automate the simulation process. Within just a few minutes and several lines of Python code you can reduce tasks that would have previously taken hours or days to seconds.

Here are just a few examples of what you might want to do with Flood Modeller’s API…

Global edits

Flood Modeller already allows you to undertake various global edits, however it’s not currently possible to update the IED and DAT files using the existing interface tools.

Using the new API, you can apply updates to climate change peak flows in ReFH boundary units, make edits to changing river section bed profiles, or even edit custom or logical rules detailing which units to update, allowing Manning's values based on resultant velocities from ZZN results.

Rapid results analysis

Flood Modeller provides a range of tools, such as the Results Extractor and Flood Viewer, which allow you to analyse results quickly and efficiently.

However, using the new API, results can be extracted and analysed directly in Python which is even faster than extracting to .csv and using Excel. It enables custom analysis scripts to be applied multiple times across different models and/or projects, allowing you to report custom result metrics in a standardised format. Results analysis in Python also benefit from having access to other files, such as incorporating the channel profile into results analysis.

Automated simulation process

Flood Modeller includes various tools such as the Batch Runner which can automate the running of simulations directly within the software.

However, the API provides added flexibility to run simulations directly from a script, allowing the results to be accessed directly. This allows users to 'close the loop' and edit simulation files, run simulations, access results, make any edits and re-run their simulations - all in an automated way.

We have made the code available on GitHub, enabling anyone to access, share and explore code, and drive community innovation.

To find out more about Flood Modeller’s API, please contact a member of our team.


bottom of page