WELCOME TO EPANET 2.

=====================

EPANET is a program for analyzing the hydraulic and water quality behavior of pressurized

pipe networks. It was developed by the U.S. Environmental Protection Agency. EPANET 2.2 is
open souce software that may be freely

copied and distributed. A complete Users Manual as well as full source code and other updates

can be accessed from https://www.epa.gov/water-research/epanet or from

https://github.com/USEPA/EPANET2.2.

FILES INSTALLED BY THE SETUP PROGRAM

====================================

The setup program for EPANET 2.2 places the following files into your EPANET 2.2 installation

directory:

epanet2w.exe -- the Windows version of EPANET 2.2

runepanet.exe -- the DOS command line version of EPANET 2.2

epanet2.dll -- the numerical engine used by both epanet2w and runepanet

epanet2.chm -- the EPANET 2.2 Help file

tutorial.chm -- the on-line tutorial

notes.txt -- this file

EXAMPLE NETWORKS

================

EPANET 2.2 also comes with four example pipe networks to help one become familiar with the

program. They are placed in a sub-folder named "EPANET Projects\Examples" in your

Documents

folder and consist of the following files:

net1.net -- a simple pipe network modeling chlorine decay

net2.net -- an example of a tracer study utilizing calibration data

net2-FL.dat -- calibration data used with net2.net

net3.net -- a larger network model illustrating source tracing

net4.net -- a simple pipe network illustrating pressure driven analysis (steady state)
When running any of these networks we recommend that you view the Project Summary first

(select Project >> Summary from the main menu) to read any background notes about the

example.

NEW FEATURES IN VERSION 2.2

===========================

1. Pressure-dependent demands.

2. More robust convergence criteria.

3. Faster solution times for single period analyses.

4. Improved handling of near-zero flows.

5. Allowing tanks to overflow when full.

6. Improved water quality mass balances.

7. A comprehensive set of API functions that allows:

a. the engine to be run in a thread-safe manner

b. network elements to be created and deleted in code

c. all network data to be retrieved and modified in code.

LICENSE

=======

Please see license at

https://github.com/USEPA/EPANET2.2/blob/master/SRC_engines/LICENSE. EPANET 2.2 is a
collaboration with the EPANET open source community at
https://github.com/OpenWaterAnalytics/EPANET.

DISCLAIMER

==========

The authors of this program and the U.S. Environmental Protection Agency are not responsible

and assume no liability whatsoever for any results or any use made of the results obtained

from this program, nor for any damages or litigation that result from the use of this program

for any purpose. Portions of the research associated with EPANET 2.2 were conducted by EPA.
EPANET 2.2 has been subjected to review by the Office of Research and Development and
approved for release.

Approval does not signify that the EPANET 2.2 reflect the views of the Agency, nor does
mention of trade names

or commercial products constitute endorsement or recommendation for use.

EPANET
Application for Modeling Drinking Water
Distribution Systems
EPANET is a software application used throughout the world to model water
distribution systems. It was developed as a tool for understanding the movement
and fate of drinking water constituents within distribution systems, and can be
used for many different types of applications in distribution systems analysis.
Today, engineers and consultants use EPANET to design and size new water
infrastructure, retrofit existing aging infrastructure, optimize operations of tanks
and pumps, reduce energy usage, investigate water quality problems, and prepare
for emergencies. It can also be used to model contamination threats and evaluate
resilience to security threats or natural disasters.
Software, Compatibility, and Manuals

EPANET is public domain software that can be freely copied and distributed. It
is a Windows®-based program that will work with all versions of Windows.
Continued development and bug fixes are occurring under an open source project
site in GitHub. Software bugs and feature requests can be reported on the site as
issues, and information is available for those interested in contributing to the
code and/or viewing the quality assurance plan, contributor guidelines, software
development roadmap, automated testing suite, and other information.

 EPA’s GitHub site for EPANET 2.2 open source project

Capabilities

With EPANET, users can perform

extended-period simulation of the hydraulic and water quality behavior within
pressurized pipe networks, which consist of pipes, nodes (junctions), pumps,
valves, storage tanks, and reservoirs. It can be used to track the flow of water in
each pipe, the pressure at each node, the height of the water in each tank, a
chemical concentration, the age of the water, and source tracing throughout the
network during a simulation period.

EPANET's user interface provides a visual network editor that simplifies the
process of building pipe network models and editing their properties and data.
Various data reporting and visualization tools are used to assist in interpreting the
results of a network analysis, including color-coded network maps, data tables,
energy usage, reaction, calibration, time series graphs, and profile and contour
plots.

Hydraulic Modeling

Full-featured and accurate hydraulic modeling is a prerequisite for doing

effective water quality modeling. EPANET contains a state-of-the-art hydraulic
analysis engine that includes the following capabilities:

 Ability to use pressure dependent demands in hydraulic analyses.

 System operation based on both simple tank level or timer controls and on
complex rule-based controls.
 No limit on the size of the network that can be analyzed.
  Computes friction headloss using the Hazen-Williams, Darcy-Weisbach,
or Chezy-Manning formulas.
 Includes minor head losses for bends, fittings, etc.
 Models constant or variable speed pumps.
 Computes pumping energy and cost.
 Models various types of valves, including shutoff, check, pressure
regulating, and flow control.
 Allows storage tanks to have any shape (i.e., diameter can vary with
height).
 Considers multiple demand categories at nodes, each with its own pattern
of time variation.
 Models pressure-dependent flow issuing from emitters (sprinkler heads).
 Provides robust results for hydraulic convergence and low/zero flow
conditions.

Water Quality Modeling

In addition to hydraulic modeling, EPANET provides the following water quality

modeling capabilities:

 Storage tanks as being either complete mix, plug flow, or two-

compartment reactors.
 Movement of a non-reactive tracer material through the network over
time.
 Movement and fate of a reactive material as it grows or decays with time.
 Age of water throughout a network.
 Percent of flow from a given node reaching all other nodes over time.
 Reactions in the bulk flow and at the pipe wall.
 Accounts for mass transfer limitations when modeling pipe wall reactions.
 Allows growth or decay reactions to proceed up to a limiting
concentration.
 Employs global reaction rate coefficients that can be modified on a pipe-
by-pipe basis.
 Allows wall reaction rate coefficients to be correlated to pipe roughness.
 Allows for time-varying concentration or mass inputs at any location in
the network.

Water Security and Resilience Modeling

Extensions to EPANET are available that work with the existing software to
simulate the interactions between multiple chemical and biological agents and
their interactions with the bulk water and pipe walls in water distribution
systems.

 EPANET-MSX (Multi-Species eXtension) enables EPANET to model

complex reactions between multiple chemical and biological species in
both the bulk flow and at the pipe wall. This capability has been included
into both a stand-alone executable program as well as a toolkit library of
functions that programmers can use to build customized applications.
EPANET-MSX allows users the flexibility to model a wide-range of
chemical reactions of interest, including, auto-decomposition of
chloramines to ammonia, the formation of disinfection byproducts,
biological regrowth, combined reaction rate constants in multi-source
systems, and mass transfer limited oxidation-pipe wall adsorption
reactions.
 EPANET-RTX (Real–Time eXtension) provides the methods and
software tools by which operational data can be connected with a network
infrastructure model, and the resulting network simulation model can be
calibrated, verified, and continually tested for accuracy using operational
data. EPANET-RTX is software for building real-time hydraulic and
water quality models. EPANET-RTX brings real-time analytics to water
distribution system modeling, planning, and operations. Analytics refer to
the discovery and interpretation of patterns in data. EPANET-RTX
software works by providing access accessing available utility data and
effectively using it to run a hydraulic and water quality model.

Programmer's Toolkit

This toolkit is a dynamic link library (DLL) of functions that allow developers to
customize EPANET to their own needs. The functions can be incorporated into
32-bit Windows applications written in C/C++, Visual Basic, or any other
language that can call functions within a Windows DLL. There are over 50
functions that can be used to open a network description file, read and modify
various network design and operating parameters, run multiple extended-period
simulations accessing results as they are generated or saving them to file, and
write selected results to a file in a user-specified format.

The toolkit is useful for developing specialized applications, such as optimization

or automated calibration models that require running many network analyses. It
can simplify adding analysis capabilities to integrated network-modeling
environments based on computer-aided design (CAD), geographical information
system (GIS), and database packages. A Windows Help file is available to
explain how to use the various toolkit functions. It offers some simple
programming examples. The toolkit also includes several different header files,
function definition files, and .lib files that simplify the task of interfacing it with
code.
Applications

EPANET helps water utilities maintain and improve the quality of water delivered to
consumers. It can be used for the following:

Design sampling programs

Study disinfectant loss and byproduct formations

Conduct consumer exposure assessments

Evaluate alternative strategies for improving water quality

Modify pumping and tank filling/emptying schedules to reduce water age

Use booster disinfection stations at key locations to maintain target residuals

Plan and improve a system's hydraulic performance

Assist with pipe, pump, and valve placement and sizing

Energy minimization

Fire flow analysis

Vulnerability studies
EPANET 2.2

Introduction
EPANET is used to perform extended-period simulation of the hydraulic and
water quality behavior within drinking water distribution systems (e.g.,
pressurized pipe networks), which consist of pipes, nodes (junctions), pumps,
valves, storage tanks, and reservoirs. It can be used to track the flow of water in
each pipe, the pressure at each node, the height of the water in each tank, a
chemical concentration, the age of the water, and source tracing throughout the
network during a simulation period.

EPANET was developed as a tool for understanding the movement and fate of
drinking water constituents within distribution systems, and can be used for
many different kinds of applications in distribution systems analysis. Today,
engineers and consultants use EPANET to design and size new water
infrastructure, retrofit existing aging infrastructure, optimize operations of tanks
and pumps, reduce energy usage, investigate water quality problems, and
prepare for emergencies. EPANET can also be used to model contamination
threats and evaluate resilience to security threats or natural disasters.

Description
This repository was established to provide U.S. EPA’s official release of 2.2.0. The
last official release of EPANET was version 2.00.12, dated 2008. The release of
EPANET 2.2.0 represents a significant step forward in two important ways. First,
the EPANET 2.2.0 release represents a new, open source software project in
collaboration with the community at OpenWaterAnalytics
(https://github.com/OpenWaterAnalytics/EPANET) to maintain and extend
EPANET. The EPANET developers’ community at OWA
(http://community.wateranalytics.org) is composed of dedicated volunteers
from around the world who have a passion for EPANET. Second, EPANET 2.2.0
includes major updates to the hydraulic and water quality engines of EPANET
2.00.12.

This repository is being set up to bring together the EPANET engine

contributions from the EPA/OWA’s release of EPANET 2.2.0
(https://github.com/OpenWaterAnalytics/EPANET/releases/tag/v2.2) along with
U.S. EPA’s effort to update the Delphi-based user interface, user’s manual, and
the integrated Help manual, which resides within the Delphi-based EPANET
graphical user interface.

This repository is for archiving the source code and document files associated
with the EPA/OWA EPANET 2.2.0 release. Anyone interested in examining these
files can peruse the appropriate folder in this repository.

Intended Audience
The intended audience for this repository is anyone working on water
distribution system modeling and interested in knowing more about the source
code and documentation associated with the official release of EPANET 2.2.0.

License
EPANET is released under the MIT license. See the LICENSE.txt file.

Contributing
EPANET has an active open source software community including consulting
engineers, students, researchers, software companies, professional
organizations, other interested members of the public, and EPA partners. An
Open Source EPANET Initiative is at http://community.wateranalytics.org.
Anyone wanting to contribute to the open source, collaborative project for
EPANET should go to https://github.com/OpenWaterAnalytics/EPANET.
Everyone is welcome to participate in the EPANET project. Whether you are
helping others to resolve issues, reporting a new unknown issue, suggesting a
new feature that would benefit your workflow, or writing code, we value and
appreciate your time and effort. The path for contribution starts with entering
an issue at https://github.com/OpenWaterAnalytics/EPANET/issues. Examine the
open issues at this link and the conversation around them, and then get
engaged!

Finally, the issues identified and resolved here were the result of U.S. EPA's
efforts to coordinate beta testing of the EPA/OWA EPANET version 2.2.0.

The "Read-the-Docs" version of the EPANET User's Manual is available here

at https://epanet22.readthedocs.io/en/latest/. Alternatively, an Acrobat PDF
version is available for download within the User Manual
folder https://github.com/USEPA/EPANET2.2/tree/master/User_Manual.
Contact
epanet@epa.gov

EPA Disclaimer
The United States Environmental Protection Agency (EPA) GitHub project code
is provided on an "as is" basis and the user assumes responsibility for its use.
EPA has relinquished control of the information and no longer has responsibility
to protect the integrity, confidentiality, or availability of the information. Any
reference to specific commercial products, processes, or services by service
mark, trademark, manufacturer, or otherwise, does not constitute or imply their
endorsement, recommendation or favoring by EPA. The EPA seal and logo shall
not be used in any manner to imply endorsement of any commercial product or
activity by EPA or the United States Government.