epanet.de / DC Water Design Extension / Manual
How to use the DC Water Design Extension.
Start ArcView
Open the Extensions Dialog ( → )
Select the DC Water Design Extension (Put a checkmark in the box on the left side).
After the Extension is loaded, the Setup Dialog informs you about several settings. You shouldn't change them without knowing what you're doing.
The DC Water Design Extension extends the Project GUI by adding a new Menu, called DC Water Design Extension. The Menu contains the following choices:
Shows the Setup Dialog.
The Setup Dialog includes an option to choose the language of the Extension. Currently supported are the following localizations:
Arabic
English
German
Russian
![]() | Note |
|---|---|
Note that the Localization is not completed yet. It is therefore recommended that you set the language to English. |
The snapping radius used for network traces and model building is also customizable in this dialog. Usually the default setting should be kept.
The backdrop resolution specifies the resolution of the backdrop map if you write your EPANET files with backdrop maps. Set to a higher resolution if required.
The command timeout specifies the time in seconds for which the extension will wait when creating epanet files or running epanet calculations. If the EPANET run doesn't finish in time, there'll be an error message.
Deselecting the Enforce Data Model checkbox allows to relax checks on fields required for EPANET.
![]() | Tip |
|---|---|
Deselect the Enforce Data Model checkbox when editing street or sewer networks. |
Displays the EPANET Tables Dialog.
The Tables in the dialog are used to to store non-spatial EPANET data with ArcView. Typical examples of such data are pump curves or hydraulic analysis options. Before you can choose a table to use with the DC Water Design Extension, it has to be loaded into ArcView. Refer to the ArcView documentation for information on how to load tables into ArcView.
Opens the Result Tables Dialog.
The Result Tables are used to store the results of a hydraulic analysis. There are two tables, one for node results and one for link results. For performance reasons it is recommended that you use a RDBMS such as mySQL for storing the data.
To allow result file loading without having an RDBMS installed, the dialog provides the opportunity to switch to an result loader that relies on ArcView only.
Allows to split a model into different ones.
The values of the Zone field will
be used to determine to which model a network element belongs
The sub-models will be stored in subfolders named like the zones.
the section called “Merge Model” can be used to re-assemble the model automatically.
![]() | Caution |
|---|---|
The |
Merge a model that was split by the section called “Split Model”.
Because "Merge Model" is using the zone names from the main pipes theme, it is not possible to add new zones by simply adding a new folder. New zones have to be introduced in the main file first.
![]() | Caution |
|---|---|
The |
Extract separate models from the current one based on
the ByteCode content.
Splits the currently registered themes into several parts.
The parts are stored in the model folder
and numbered according to byte code that is set. For example,
all network elements with the first byte set (E.g. "1000")
are stored in the folder model/1.
The user is asked whether a new view should be created for each model. The views will be named "Model 1", "Model 2"...
If the junction theme has a HasDemand
field and its filename contains "junction", additional
demandjunction.shp files will be written
to the folder. They contain all the records for the particular model
where HasDemand is "1".
The definition query for all themes of the model will be removed by this operation.
See the section called “Byte Codes” for detailed information about byte codes.
Unlike the section called “Split Model” and the section called “Merge Model” this function support one-to-many relationships (One pipe can be part if different models).
Displays information about the DC Water Design Extension License. See section the section called “DC Water Design Extension” for the license details.
The DC Water Design Extension extends the ArcView View GUI with the following elements:
A new Menu called "DC Water Design"
Buttons
Tools
Three pop-up menus
The pop-up menus are available through clicking the right mouse button over a network feature.
The additional functionality is explained below.
Exports the hydraulic model to an EPANET input file.
The model has to be complete, running "Make EPANET Model" and "Check EPANET Model" is advisable especially for the novice user before exporting the EPANET input file.
The typical process that follows "Write EPANET File" is outlined in Figure 2.1, “Write EPANET File”. Note how this differs from the process in Figure 2.2, “Run EPANET Calculation”.
Optionally, a Backdrop Map is exported together with the EPANET model. This requires additional themes in the View e.g. pressure zones or a street layer. The resolution of the backdrop map can be specified in the setup dialog (see the section called “Project Menus”). A backdrop will only be written, if the view contains visible themes in addition to the EPANET themes.
If the Status field of a Pipe or the Setting field of
a Valve contains "closed", it will be
set to "closed".
![]() | Note |
|---|---|
The resulting EPANET input file has the extension *.inp. The *.xml-file is just an intermediate format (temporary file). |
![]() | Note |
|---|---|
The function is writing experimental OptiDesigner files
( |
Exports the hydraulic model to an EPANET input file, runs the analysis and loads the results into ArcView.
The typical "Run EPANET Calculation process" is outlined in Figure 2.2, “Run EPANET Calculation”. Note how this differs from the process in Figure 2.1, “Write EPANET File”.
The model has to be complete, running "Make EPANET Model" and "Check EPANET Model" is advisable especially for the novice user before exporting the EPANET input file.
After the analysis has been completed, the report created by EPANET is displayed in a window and the user is prompted to select a time step for which the results will be loaded.
Loads binary results of an EPANET calculation into ArcView.
The binary results need to result of from an analysis of the EPANET model currently loaded into ArcView.
The user will be prompted to select a time step for which the results will be loaded.
Imports an EPANET model from an EPANET INP file.
The EPANET INP format is an ASCII format (it can be easily edited by any text editor) that is documented in the EPANET toolkit. The windows version of EPANET can export models to this format. To export an INP file from EPANET, choose → → ) from the menu.
After selecting → from the menu, you have to do the following:
Select the location for the new
Junction shapefile to be created. |
Select the location for the new
Pipe shapefile to be created. |
Select the location for the new
Pump shapefile to be created. |
Select the location for the new
Reservoir shapefile to be created. |
Select the location for the new
Tank shapefile to be created. |
Select the location for the new
Valve shapefile to be created. |
| Select the EPANET INP file to be imported. |
If there are errors, they will be reported in a separate window.
![]() | Caution |
|---|---|
Currently the function will not import the full EPANET model. Be sure to check whether the imported results fit your needs. |
The function uses the inp2shp command. (the section called “inp2shp”).
Performs a number of checks on the hydraulic model.
The checks include the following:
Check for NULL shapes
Check for pipes shorter than the snapping radius
Check for duplicate IDs
Check for IDs that are too long
Loads the results of an EPANET hydraulic analysis to ArcView.
The hydraulic analysis has to be run from ArcView in order to to enable this feature. The user is prompted to select the time step for which the results should be loaded.
Creates the line-node structure required by EPANET.
This function fills the fields node1 and node2 in the links table with the dc_ids of the connected nodes. The fields will be overwritten by this function, therefore the user has to confirm the action before the script run.
After completion, a report gives a overview of the created model. Model creation errors are also reported. If there were errors, the features in question are selected after the run.
In case there are reports about inconsistent flow direction at pumps or valves, you can use the "Flip Polylines" tool to correct the errors (the section called “Flip Polylines”).
![]() | Tip |
|---|---|
Increase the snapping radius if necesary (the section called “Setup”. |
Opens the EPANET Themes Dialog.
Use the Dialog to select the themes you want to use in your hydraulic model. The line and node theme are required, other themes are optional and can be switched off with the check boxes on the right side.
![]() | Important |
|---|---|
Most of the extension functions require that the EPANET Themes are properly set up in this dialog. |
Setting up the themes should be the first step when using the extension. The settings are also used to determine which themes should be edited.
Displays the EPANET Tables Dialog.
The Tables in the dialog are used to to store non-spatial EPANET data with ArcView. Typical examples of such data are pump curves or hydraulic analysis options. Before you can choose a table to use with the DC Water Design Extension, it has to be loaded into ArcView. Refer to the ArcView documentation for information on how to load tables into ArcView.
Allows to set valve states according to EPANET Controls.
If a controls table is registered with the Extension (see the section called “EPANET Tables”), the user is offered to select the controls he would like to apply. All chosen controls are applied. This is very useful in combination with Network Traces as the extension allows to stop traces at closed valves.
Creates a straight pipe between tanks and junctions which share an id.
This function requires some preparatory work: Each tank of the tanks theme needs to know to which junction he should be connected. This is expressed with a field in the tanks attribute table that contains the dc_id of the junction the tank should connect to. Such fields can be established e.g. by using the spatial join function of the Geoprocessing Wizard.
![]() | Note |
|---|---|
Note that this functionality has been included mainly for the purpose of modeling intermittent supply with household storage tanks. |
It might be taken out or completely rewritten in future versions of the DC Water Design Extension.
Calculates a coded text that shows when a node is supplied with water.
This might only be used after successfully running an EPANET hydraulic analysis from ArcView. The function will query the the nodes results table for pressures above zero. Each pressure above zero will yield a "1" in the supply string, a pressure below or equal zero will yield a "0" in the supply string. For each node, the supply strings are written to a user-selectable text field. The field has to been long enough to contain as many characters as there are time steps in the EPANET results.
![]() | Note |
|---|---|
Note that this functionality has been included mainly for the purpose of modeling intermittent supply with household storage tanks. |
It might be taken out or completely rewritten in future versions of the DC Water Design Extension.
This function calculates the length of the pipes connected to a junction.
A user selectable number field in the junctions attribute table is filled with the length of the pipes connected to each junction. In order not to double the overall pipe length, each pipe length is divided by two. Thus every part of a pipe is assigned to the nearest node.
Creates new themes with features which have the same bit set in a bit code.
The function works with all active themes in the view. First, the user is prompted to select the bit which has to be set for the clipped themes. Then the field containing the bit code has to be chosen. (The script assumes that the bit code field names are the same throughout all the active themes.) The user can select the filename and location for each clipped theme. He can also choose whether the new themes should be added to the view.
Creates a sequence (string) of 0 and 1 for describing if the pipe is connected to a reservoir at over a sequence of hours.
A user selectable text field in the pipe attribute table is filled with a string containing 0's and 1's. The n-th character is a 0 if the pipe is not connected to a reservoir in the n-th hour or 1 if the pipe is connected.
A string "00111" means that the pipe was supplied from the second to the fifth hour.
Such information can be used to automatically determine zones for networks with intermittent supply. Zones are disconnected by the shut off valves. The shut off valves are controlled by the controls table. The supported control syntax is:
LINK link_id status AT TIME hours_since_simulation_start
The number of traces - which is equal to the number of hours from simulation start - can be chosen by the user. The function requires the Epanet model to be set up correctly (Including valves and controls).
Currently the function only supports networks that contain only shut off valves.
Creates fields required by the data model if they are missing in the EPANET themes.
This allows to quickly create data sets that conform with the EPANET data model.
Tools that are added to the View GUI.
This tool allows to flip the digitizing direction of lines.
The theme containing the lines to be flipped has to be set up as the pipe theme in the EPANET themes dialog. Simple clicking on the line will switch the digitizing direction.
![]() | Tip |
|---|---|
ArcView's symbology can be used to display the digitizing direction with arrowheads. |
A tool to move network nodes including rubber-banding.
With this tool it's possible to move network nodes (junctions, tanks, reservoirs, pumps, valves) along with the connected pipes. The network stays intact and fully connected (rubber-banding).
The respective themes have to be registered with the extension in the EPANET themes dialog.
Tool that allows to split a pipe into two pipes. Adds a new junction at the split point.
The two new pipes inherit the attributes from the original pipe. However, the length gets recalculated based on the shapes.
Pipe and junction themes have to be chosen in the EPANET themes dialog.
Allows to re-shape pipes.
Vertices determine the route of a pipe. The tool makes it possible to move all the vertices of a pipe. Additional, it's possible to add vertices to the pipe. Unlike the ArcView tool "Vertex Edit", "Edit Pipe Vertices" ensures network connectivity - it is impossible to disconnect a pipe from a node with this tool.
The pipe theme has to be set up in the EPANET themes dialog in order to use this tool.
![]() | Important |
|---|---|
Note that the pipe length is not recalculated. |
Recalculate the pipe length manually in the pipe theme attribute table. See the Questions and Answers section of this manual if you have problems calculating the pipe length.
Tool to convert nodes from one class to another.
The Change Node Class tool allows to convert e.g. a junction into pump. Attributes shared between the two classes are copied. After selecting an existing node, the user is prompted to select the class to which the node should be moved. The old node is deleted.
Obviously, the respective themes have to be registered with the extension in the EPANET themes dialog.
A tool to delete network features.
Allows one-click deletion of network features. The user is prompted to confirm the deletion. Remember that there's no undo support with the DC Water Design Extension.
The themes containing features that should be deleted have to be selected in the EPANET Themes dialog.
The Digitize Junction tool is used to digitize junctions.
The junctions are added to the junction theme selected in the EPANET themes dialog.
The Digitize Pipe tool is used to digitize pipes.
The pipes are added to the pipe theme selected in the EPANET themes dialog. In order to maintain the network integrity, the tool automatically adds junctions at the pipe end if the pipe end doesn't snap onto an existing node.
The Digitize Tank tool is used to digitize tanks.
The tanks are added to the tank theme selected in the EPANET themes dialog.
The Digitize Valve tool is used to digitize valves.
The valves are added to the valve theme selected in the EPANET themes dialog. The tool is disabled if the valve theme is not enabled in the EPANET themes dialog.
The context menu items described in this section are available if the right mouse button is pressed over a theme that has been registered with the DC Water Design Extension (See the section called “EPANET Themes”).
Pop-up menu item that allows to show the attributes of a pipe.
Right-clicking on a pipe and selecting this menu item opens the pipe attribute table, selects and promotes the pipe.
The appropriate pipe theme has to be selected in the EPANET themes dialog.
Pop-up menu item allowing to edit the attributes of a pipe.
Right-clicking on a pipe and selecting this menu item opens the pipe attribute table, makes it editable, selects and promotes the pipe record. After that, the attributes of the pipe can be edited. Keep in mind that there's no undo.
Pop-up menu item that allows to trace the pipes connected to the selected pipe.
Right-clicking on a pipe and selecting this menu item opens a dialog that offers node types at which the trace should stop. Multiple types can be selected. During the trace, the status bar informs what percentage of the network has been covered by the trace so far. Note that the progress bar won't make it to 100% unless the network is fully connected and no stopper has been selected. The connected pipes up to all stop points are returned as the selection.
![]() | Tip |
|---|---|
The option "Closed Valves" will stop if
a feature in the valve theme contains the text "closed" in
the field |
Interactively traces connected pipes.
See the section called “Select Connected Pipes” for more information on network traces.
Select the pipe diameter from a list. The economic diameter will be selected by default based on the flow rate result.
Example 2.1. Economic Diameter Selection
The field result_flow of the pipe table contains a value of 15 l/s. In this case a DN 150 pipe will be suggested. The resulting velocity will be 0.85 m/s.
![]() | Important |
|---|---|
This function only works when "LPS" units are used (Field Units of the EPANET options table). |
Pop-up menu item that shows the attributes of a node.
Right-clicking on a node and selecting this menu item opens the node attribute table, selects and promotes the pipe.
The appropriate node theme has to be selected in the EPANET themes dialog.
Pop-up menu item that allows to edit the attributes of a node.
Right-clicking on a node and selecting this menu item opens the node attribute table, makes it editable, selects and promotes the node record. After that the attributes of the node can be edited. Keep in mind that there's no undo.
Table buttons that are added by the extension.
The Bytecode Calculator is accessible from the button bar of the table GUI. It is disabled unless the table is editable and a numerical field is selected.
Upon clicking on the Bytecode Calculator button, the user is prompted to select the bits he wants to set.
After choosing OK, the bit code will be calculated and written to all the selected records.
If no records are selected the bit code is written to all the records in the table.
The field used to store the byte codes should have no decimal places.
See the section called “Byte Codes” for details regarding byte codes.
Several commandline tools that are available together with the DC Water Design Extension.
If you do not know what a commandline tool is, you may want to skip this section as the DC Water Design Extension provides
Note that these tools don't rely on ArcView and may be used independent of the DC Water Design Extension.
Converts EPANET INP files to a group of shapefiles that conform to the EPANET/ArcView data model.
Used by the EPANET INP import function (the section called “Import EPANET Inp File”).
The command is used as follows:
inp2shpmodel.inp
model.txt
j.shp
p.shp
pu.shp
r.shp
t.shp
The inp2shp program. | |
The INP file to be imported. Replace with the path to your INP file. | |
A report file to be generated by the EPANET engine. The file might contain additional error message that can help to track down problems. Existing file will be overwritten! | |
The junction shapefile to be generated or overwritten. Replace with the path to save the junction shapefile. Existing files will be overwritten! | |
The pipe shapefile to be generated or overwritten. Replace with the path to save the pipe shapefile. Existing files will be overwritten! | |
The pump shapefile to be generated or overwritten. Replace with the path to save the pump shapefile. Existing files will be overwritten! | |
The reservoir shapefile to be generated or overwritten. Replace with the path to save the reservoir shapefile. Existing files will be overwritten! | |
The tank shapefile to be generated or overwritten. Replace with the path to save the tank shapefile. Existing files will be overwritten! |
Shapefiles will only be generated for those network elements that are included in the INP file.
Virtual lines are processed as required (See the section called “Virtual Lines”).
![]() | Important |
|---|---|
Make sure that inp2shp.exe and
the patched |
Convert binary EPANET result files to comma separated ASCII files.
Used by several functions (the section called “Run EPANET Calculation”, the section called “Import Binary Result File”, the section called “Load Results for Step ...”)