Skip to content

SWMMEnablement/NCIMM-Regression-Test-Files

Repository files navigation

NCIMM Regression Test Files

A curated collection of SWMM5 input (.inp), data, calibration, and log-comparison files used to regression-test the NCIMM build of the EPA Storm Water Management Model.

These files are used to verify that successive SWMM5 engine versions (notably v12 vs v13) produce consistent hydrologic and hydraulic results across a wide range of model features.

Purpose

  • Provide a reproducible regression test suite for SWMM5 engine development.
  • Compare results between SWMM5 v12 and v13 (and related branches such as LEW_update_v5113 and OWA_update_v5111).
  • Support QA for derivative tools (InfoSWMM, XPSWMM, OWA SWMM, NCIMM).

Repository Layout

Test model inputs (.inp files)

Folder Focus area
Hydraulics Core hydraulic routing test cases
Hydrology Rainfall-runoff and subcatchment tests
LID Low Impact Development control tests
Orifices Orifice element tests
Weirs Weir element tests
Pumps Pump curve and operation tests
SWMM5_NCIMM NCIMM-specific test models

OWA (Open Water Analytics) test suites

Folder Focus area
OWA_EXAMPLES OWA reference example models
OWA_EXTRAN Extended transport / dynamic-wave tests
OWA_ROUTING Routing tests
OWA_USER User-contributed OWA tests
OWA_update_v5111 OWA update branch (v5.1.11) tests
LEW_update_v5113 LEW update branch (v5.1.13) tests

Third-party / vendor models

Folder Focus area
InfoSWMM Model Folders InfoSWMM regression models
XPSWMM XPSWMM-derived test models

Supporting data

Folder Contents
Calibration_Files Calibration data for v12/v13 runs
DataFiles Auxiliary data (rainfall, time series, climate) referenced by the .inp files
v12 v12 log / output comparison files
v13 v13 log / output comparison files

File Formats

  • .inp - SWMM5 input model (text)
  • .rpt / .out - SWMM5 simulation report and binary output
  • .dat / .txt - Time series, rainfall, and other supporting data
  • .json - JSON-serialized SWMM5 model/data (where available)

Running a Test

  1. Install a SWMM5 engine build (EPA SWMM 5.1/5.2, OWA SWMM, or NCIMM).
  2. Pick an .inp file from any test folder.
  3. Place any referenced support files from DataFiles/ alongside the .inp (or update its paths).
  4. Run the engine, e.g.:
    swmm5 model.inp model.rpt model.out
    
  5. Compare the resulting .rpt / .out against the reference logs in v12/ and v13/.

Documentation

  • EPASWMM_UserManual.md - reference notes on the EPA SWMM user manual.
  • Per-folder readme.md files describe individual test sets where available.

Related

Contributing

Issues and pull requests with new regression cases, corrected reference logs, or improved documentation are welcome. Please:

  1. Place new .inp files in the most relevant existing folder (or propose a new one in your PR).
  2. Include both v12 and v13 reference outputs when possible.
  3. Keep model file sizes modest; large binary outputs should be summarized in v12/ or v13/ logs.

License

No explicit license has been declared for this repository. Test models contributed from EPA SWMM, OWA, InfoSWMM, and XPSWMM retain their respective upstream licenses.

About

SWMM5 JSON and InpFiles

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors