Reference · Guides · APIs

Documentation

Every layer of the ecosystem, documented: the interface definitions that make coupling possible, the SDK for building components, and the Open-Source SWMM 6.0 (SWMM2D) engine with its Python, real-time control, and agent tooling.

The standard

Framework & component development

HydroCouple Interface Definitions

The C++ specification at the heart of the framework: component lifecycle, exchange items, geospatial data types, time semantics, and HPC interfaces.

HydroCouple SDK

Base implementations of the interface definitions so wrapping a model starts from working code, the fastest path to a conforming component.

The flagship

Open-Source SWMM 6.0 (SWMM2D)

Engine · C / C++ API

Full C API reference, hydrology, hydraulics, and water-quality reference manuals, user manual, and architecture notes for the next-generation computational engine.

Python Bindings

Quickstart, per-domain user guide, Cython API reference, and the SWMM 5 → v6 migration guide for the openswmm package.

Desktop Application

The cross-platform modeling environment: map editing, 2D mesh generation, scenario management, result visualization, and profile and comparison plotting.

Gymnasium Environments

Real-time control environments over the engine for smart stormwater operations: standard Gymnasium APIs, benchmark scenarios, and optimization workflows.

Benchmarks Platform

The open verification and regression-testing platform: 1,396 benchmark models, exact analytical solutions, mass-balance and stability sweeps, and the public dashboard tracking every engine.

MCP Agent Tooling

The Model Context Protocol server for LLM-driven modeling: tool catalog, agent skills, and workflows for building, running, and analyzing models with AI agents.

More documentation sets, including component developer guides and FVQual, will appear here as they mature. Each is one card: icon, summary, links.