Flood Modeller Python API

This python package is designed to be used in conjunction with your installation of Flood Modeller to provide users with a set of tools to extend the capabilities of Flood Modeller and build into automated workflows.

Installation

You can install the floodmodeller_api package from PyPI with the following command:

pip install floodmodeller-api

Flood Modeller API is regularly tested for all versions of python 3.10 onwards. Although it may work for older versions of python, we recommend using at least v3.10 and ideally the latest stable release.

Once you have installed floodmodeller_api to your python environment, you can import the package with:

import floodmodeller_api  # imports the full package
from floodmodeller_api import DAT, ZZN, IEF, IED  # imports individual classes (recommended)

How to use

The best place to start is to go directly to the Flood Modeller Python API Documentation

The Flood Modeller Python API is designed for users already familiar with both Flood Modeller and Python. The API is built up using distinct python classes for each of the key Flood Modeller file formats as well as key themes. The purpose of the API is not to provide ready-to-use tools for specific tasks, as there is an extensive set of tools already provided within Flood Modeller, many of which can be called from both within and outside of the Flood Modeller software. Instead, this API provides the building blocks for users to build their own custom workflows and tools which can integrate seamlessly with Flood Modeller.

Show and Tell

In the spirit of open source, we encourage you to share any interesting scripts or tools you have developed using the Flood Modeller Python API. To do this, please get involved in the discussions section here. This is also a great place to explore different ways that people have used the API.

Youtube mini tutorials

These videos give you a quick overview of some of the basics of using the Flood Modeller API

Running a simulation

Using the codespace

Extract ReFH2 csv data into IEDs and QTBDYs