How openwateranalytics/epanet works
Project type and purpose
• OWA-EPANET is not a web-app or microservice suite but a C-based toolkit and command-line program for simulating hydraulic and water-quality behavior in pipe networks. It exposes a Programmer’s Toolkit (API library) plus a CLI “run” executable that uses that library.
File structure
• Top-level:
• CMakeLists.txt, conanfile.py, BUILDING.md → build & package
• / → public API headers (epanet2.h, enums, language bindings)
• src/ → core engine (hydraulics, water quality, I/O, memory, error handling, output module)
• run/ → CLI wrapper main.c
• tests/ → automated unit/integration tests, data, test-output generators
• tools/ → helper scripts for CI, config, reporting
• doc/ → Doxygen docs & examples
• Patterns: modular C code separated by functionality (input parser, solver, output), single static/shared library built with CMake, conan support.
a. Main components
• CLI Frontend (run/main.c)
• Input Parser module (src/input*.c)
• Memory & Error Manager (src/util/filemanager.c, src/util/errormanager.c, mempool)
• Hydraulic Solver (src/hydraul.c, hydsolver, flowbalance, hydstatus)
• Water-Quality Solver (src/qualreact.c, qualroute.c, quality.c)
• Reporting & Output (src/report.c, src/output.c, src/outfile/)
• Public API Layer (include/epanet2.h + language bindings)
• Build & CI (CMake, Conan, workflows)
• Test Harness (tests/)
b. Relationships & data flow
1. CLI reads network input file → calls API’s EN<function>
2. API delegates to Input Parser → builds in-memory network model
3. Model fed to Hydraulic Solver → computes flows/pressures
4. Results passed to Quality Solver → computes concentrations
5. Output Writer / Reporter formats results → writes text/binary files
6. CLI prints/returns exit code
7. Memory & Error Manager supports all modules for allocation & logging
c. Architectural patterns & principles
• Modular layering: CLI → API → core engine → util → OS I/O
• Single codebase delivering both library (static/shared) and executable
• Separation of concerns: parsing, solving, reporting
• Build-system abstraction: CMake + Conan for cross-platform
d. Key technologies
• C (ANSI)
• CMake, Conan, AppVeyor, GitHub Actions for builds/tests
• Doxygen for docs
• Python for some CI tools (tools/nrtest-epanet)
Elements
• Notes on tools: CMake, Doxygen, Conan