Introduction

The Flood Modeller Python API enables users of Flood Modeller to create their own automated workflows, it extends the capabilities of Flood Modeller, and it unlocks new and imaginative ways to use Flood Modeller.  It is also available a free and open-source python package.

Background

Developed by Jacobs, Flood Modeller is an industry-leading software for modelling rivers, surface water and urban drainage using both 1D and 2D solvers. Building on 50+ years of development it is currently used widely in the UK and is independently benchmarked by the Environment Agency.

Flood Modeller has a feature-rich user interface, which is one of its key market differentiators. Until now bespoke tools and in-depth knowledge of the data files has been needed to integrate the software with automated workflows, such as tools that update the parameters in river networks.

Our solution

In 2021, development began on a new python package that would provide a simple way for users to interact with Flood Modeller’s main data formats and initiate model runs (simulations). This then grew into the ‘Flood Modeller Python API’. Access the Flood Modeller API documentation here.