epanetparser documentation master file.

The epanetparser Documentation

epanetparser is a toolkit for parsing, validating and converting EPANET water distribution network models. It works with both EPANET INP (text) format and WNTR JSON format.

The toolkit consists of a command-line utility and a library, which together allow epanetparser to be used directly and as a component of other projects.

Parsing and validation are separate steps. Parsing builds a model and reports only structural problems. Validation runs afterwards against a chosen rule set and returns a structured report, so a model can be a valid EPANET model and still be rejected by an application-specific rule set.

The epanetparser source code is hosted on GitHub.

Introduction

• Basic Usage
  • Overview
• Installation
  • Validation
  • Exit status
  • Selecting a rule set
  • Converting between formats
  • Downloading additional networks
  • Inspecting rule sets
  • Configuration
• Class Hierarchy
  • Overview
  • Model layer
  • Validation engine
  • Rule sets and exceptions

Rules and Rulesets

• Rules, Warnings, and Rule Sets
  • Overview
  • Adding a rule
  • Restricting a rule with match
  • Network rules
  • How a rule fails
  • Defining a rule set
  • Discovery
  • The core rule set

The epanetparser library

• The epanetparser Library
  • The WNTREPANETNetwork class
  • The WNTRJSONParser class
• Usage
  • Overview
  • The errors and warnings objects
  • Rule sets
  • Results

Indices and tables

• Index

• Search Page