Welcome to Flood Modeller API’s documentation!

Flood Modeller API is a python package which provides a bridge between Flood Modeller and the python programming language to extend the capabilities of Flood Modeller in automated workflows.

Getting Started

If you’re new to Flood Modeller Python API then this is the place to start.

Get started

User Guide

A comprehensive guide to each of the main python classes, plus code reference and examples.

Go to user guide

Release Notes

Details of the latest updates and features.

Go to release notes

Support and Feedback

Get support using Flood Modeller and Python, and help improve Flood Modeller Python API by providing feedback to the developers.

Support & Feedback

Contents

• Getting Started
  • GitHub Codespace
    • Installation and Importing
    • Licensing
    • API Overview
• User Guide
  • DAT Class
    • Summary
    • Reference
    • Examples
  • XML2D Class
    • Summary
    • Add and remove functionality
    • Reference
    • Examples
  • IEF Class
    • Summary
    • Reference
    • Examples
  • ZZN Class
    • Summary
    • Reference
    • Examples
  • ZZX Class
    • Summary
    • Reference
    • Examples
  • IED Class
    • Summary
    • Reference
    • Examples
  • INP Class
    • Summary
    • Reference
    • Examples
  • LF Classes
    • Summary
    • Reference
    • Examples
  • Individual Unit Classes
    • Boundary units
    • Section units
    • Conduit units
    • Structure units
    • Loss units
    • Connector units
    • Control units
  • Individual Urban 1D Unit Classes
    • Junction Units
    • Raingauge Units
    • Outfall Units
    • Conduit Units
    • Loss Units
    • XSection Units
  • Hydrology+
    • Summary
    • Hydrology+ exported flow data
    • Generating IEF data
    • Reference
  • API Toolbox
    • Summary
    • Run a tool
    • Developing Custom Tools
    • Reference
  • List of API Tools
    • StructureLog
    • AddSiltation
  • Additional Functionality
    • Difference and equivalence methods
    • File Backups
    • JSON methods
    • Quick methods to reading files
  • Indices and tables
• Release Notes
  • What’s new in 0.5.2 (February 2025)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.5.1 (November 2024)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.5.0 (September 2024)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.4.4 (June 2024)
    • Updates
  • What’s new in 0.4.3 (April 2024)
    • Updates
  • What’s new in 0.4.2 (October 2023)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.4.1 (March 2023)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.4.0 (September 2022)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.3.14 (July 2022)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.3.13 (May 2022)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.3.12 (February 2022)
    • New features
    • Updates
    • Bug fixes
  • What’s new in 0.3.11 (January 2022)
    • New features
    • Updates
    • Bug fixes
• Support & Feedback
  • Flood Modeller API GitHub site
  • Flood Modeller Support
  • Python resources
  • User Feedback