Arc Hydro Tools - Tutorial
Version 1.1 Final - September 2005
ESRI 380 New York St., Redlands, CA 92373-8100, USA • TEL 909-793-2853 • FAX 909-793-5953 • E-MAIL info@esri.com • WEB www.esri.com
Arc Hydro Tools v1.1 Final – Tutorial
Copyright © 2005 ESRI
All rights reserved.
Printed in the United States of America.
The information contained in this document is the exclusive property of ESRI. This work is protected under United States
copyright law and other international copyright treaties and conventions. No part of this work may be reproduced or
transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, or by any
information storage or retrieval system, except as expressly permitted in writing by ESRI. All requests should be sent to
Attention: Contracts Manager, ESRI, 380 New York Street, Redlands, CA 92373-8100, USA.
The information contained in this document is subject to change without notice.
U.S. GOVERNMENT RESTRICTED/LIMITED RIGHTS
Any software, documentation, and/or data delivered hereunder is subject to the terms of the License Agreement. In no event
shall the U.S. Government acquire greater than RESTRICTED/LIMITED RIGHTS. At a minimum, use, duplication, or
disclosure by the U.S. Government is subject to restrictions as set forth in FAR §52.227-14 Alternates I, II, and III (JUN
1987); FAR §52.227-19 (JUN 1987) and/or FAR §12.211/12.212 (Commercial Technical Data/Computer Software); and
DFARS §252.227-7015 (NOV 1995) (Technical Data) and/or DFARS §227.7202 (Computer Software), as applicable.
Contractor/Manufacturer is ESRI, 380 New York Street, Redlands, CA 92373-8100, USA.
ESRI, ARC/INFO, ArcCAD, ArcIMS, ArcView, BusinessMAP, MapObjects, PC ARC/INFO, SDE, and the ESRI globe logo
are trademarks of ESRI, registered in the United States and certain other countries; registration is pending in the European
Community. 3D Analyst, ADF, the ARC/INFO logo, AML, ArcNews, ArcTIN, the ArcTIN logo, ArcCOGO, the ArcCOGO
logo, ArcGrid, the ArcGrid logo, ArcInfo, the ArcInfo logo, ArcInfo Librarian, ArcInfo—Professional GIS, ArcInfo—The
World's GIS, ArcAtlas, the ArcAtlas logo, the ArcCAD logo, the ArcCAD WorkBench logo, ArcCatalog, the ArcData logo,
the ArcData Online logo, ArcDoc, ArcEdit, the ArcEdit logo, ArcEditor, ArcEurope, the ArcEurope logo, ArcExplorer, the
ArcExplorer logo, ArcExpress, the ArcExpress logo, ArcFM, the ArcFM logo, the ArcFM Viewer logo, ArcGIS, the ArcGIS
logo, the ArcIMS logo, ArcNetwork, the ArcNetwork logo, ArcLogistics, the ArcLogistics Route logo, ArcMap, ArcObjects,
ArcPad, the ArcPad logo, ArcPlot, the ArcPlot logo, ArcPress, the ArcPress logo, the ArcPress for ArcView logo, ArcReader,
ArcScan, the ArcScan logo, ArcScene, the ArcScene logo, ArcSchool, ArcSDE, the ArcSDE logo, the ArcSDE CAD Client
logo, ArcSdl, ArcStorm, the ArcStorm logo, ArcSurvey, ArcToolbox, ArcTools, the ArcTools logo, ArcUSA, the ArcUSA
logo, ArcUser, the ArcView logo, the ArcView GIS logo, the ArcView 3D Analyst logo, the ArcView Business Analyst logo,
the ArcView Data Publisher logo, the ArcView Image Analysis logo, the ArcView Internet Map Server logo, the ArcView
Network Analyst logo, the ArcView Spatial Analyst logo, the ArcView StreetMap logo, the ArcView StreetMap 2000 logo,
the ArcView Tracking Analyst logo, ArcVoyager, ArcWorld, the ArcWorld logo, Atlas GIS, the Atlas GIS logo, AtlasWare,
Avenue, the Avenue logo, the BusinessMAP logo, the Data Automation Kit logo, Database Integrator, DBI Kit, the Digital
Chart of the World logo, the ESRI Data logo, the ESRI Press logo, ESRI—Team GIS, ESRI—The GIS People, FormEdit,
Geographic Design System, Geography Matters, GIS by ESRI, GIS Day, GIS for Everyone, GISData Server, InsiteMAP,
MapBeans, MapCafé, the MapCafé logo, the MapObjects logo, the MapObjects Internet Map Server logo, ModelBuilder,
MOLE, the MOLE logo, NetEngine, the NetEngine logo, the PC ARC/INFO logo, PC ARCEDIT, PC ARCPLOT, PC
ARCSHELL, PC DATA CONVERSION, PC NETWORK, PC OVERLAY, PC STARTER KIT, PC TABLES, the
Production Line Tool Set logo, RouteMAP, the RouteMAP logo, the RouteMAP IMS logo, Spatial Database Engine, the SDE
logo, SML, StreetEditor, StreetMap, TABLES, The World's Leading Desktop GIS, Water Writes, and Your Personal
Geographic Information System are trademarks; and ArcData, ArcOpen, ArcQuest, ArcWatch, ArcWeb, Rent-a-Tech,
Geography Network, the Geography Network logo, www.geographynetwork.com, www.gisday.com, @esri.com, and
www.esri.com are service marks of ESRI.
Other companies and products mentioned herein are trademarks or registered trademarks of their respective trademark
owners.
September 2005 iArc Hydro Tools v1.1 Final – Tutorial
Table of Contents
Introduction......................................................................................................................................1
Objective...........1
Getting Started..1
Software Requirements ...............................................................................................................1
Setting up the Arc Hydro Tools ..................................................................................................4
Installing XML Parser 4.0...........................................................................................................4
Installing the Water Utilities Application Framework ................................................................5
Installing Arc Hydro....................................................................................................................6
1. Run the Arc Hydro setup ...................................................................................................6
2. Open ArcMap and load Arc Hydro tools ...........................................................................7
Dataset Setup...............................................................................................................................9
1. Load the terrain data ..........................................................................................................9
Terrain Preprocessing11
1. DEM Reconditioning (optional) ......................................................................................11
2. Build Walls (optional)......................................................................................................13
3. Fill Sinks (optional) .........................................................................................................14
4. Flow Direction .................................................................................................................16
5. Flow Accumulation17
6. Stream Definition.............................................................................................................18
7. Stream Segmentation .......................................................................................................20
8. Catchment Grid Delineation ............................................................................................21
9. Catchment Polygon Processing........................................................................................22
10. Drainage Line Processing ..............................................................................................23
11. Adjoint Catchment Processing.......................................................................................25
12. Drainage Point Processing .............................................................................................27
13. Longest Flow Path for Catchments................................................................................28
14. L Adjoint Catchments...................................................................30
15. Slope ..............................................................................................................................31
16. Slope greater than 30......................................................................................................32
17. Slater than 30 and facing North..........................................................................33
18. Weighted Flow Accumulation34
Watershed Processing....................................................................................................................36
1. Batch Watershed Delineation...........................................................................................36
2. Batch Subwatershed Delineation .....................................................................................39
3. Drainage Area Centroid ...................................................................................................42
4. Longest Flow Path ...........................................................................................................44
5. Loow Path for Watersheds ..................................................................................45
6. Longest Flow Path for Subwatersheds.............................................................................46
7. Construct 3D Line............................................................................................................48
8. Smooth 3D Line...............................................................................................................49
9. Flow Path Parameters from 2D Line................................................................................50
10. Flow Path Parameters from 3D Line..............................................................................51
Network Tools ...............................................................................................................................53
1. Hydro Network Generation..............................................................................................53
2. Node/Link Schema Generation........................................................................................55
3. Store Flow Direction........................................................................................................56
4. Set Flow Direction ...........................................................................................................57
September 2005 iiArc Hydro Tools v1.1 Final – Tutorial
Terrain Morphology.......................................................................................................................59
1. Data Management Terrain Morphology...........................................................................59
2. Drainage Area Characterization.......................................................................................60
3. Drainage Boundary Characterization...............................................................................64
4. Drainage Connectivity Characterization..........................................................................70
Attribute Tools...............................................................................................................................74
1. Assign HydroID ...............................................................................................................74
2. Generate From/To Node for Lines...................................................................................76
3. Find Next Downstream Line............................................................................................77
4. Calculate Length Downstream for Edges ........................................................................78
5. Calculate Length Down for Junctions ...................................................................79
6. Find Next Downstream Junction......................................................................................81
7. Store Area Outlets............................................................................................................82
8. Consolidate Attributes......................................................................................................85
9. Accumulate Attributes .....................................................................................................88
10. Display Time Series.......................................................................................................90
11. Transfer ID.....................................................................................................................93
12. Transfer Value................................................................................................................95
13. Compute Local Parameters96
14. Compute Global Parameters ..........................................................................................98
Buttons and Tools..........................................................................................................................99
1. Flow Path Tracing............................................................................................................99
2. Point Delineation100
3. Batch Point Generation ..................................................................................................101
4. Assign Related Identifier ...............................................................................................102
5. Global Point Delineation................................................................................................103
6. Trace By NextDownID Attribute...................................................................................104
September 2005 iii
Arc Hydro Tools v1.1 Final – Tutorial
Introduction
The purpose of this tutorial is to illustrate, step-by-step, how to install Arc Hydro and use the major
functionality available in the tools. This is a hands-on document focusing on how, not why. There is
little discussion on implementation or internal operation of a tool. This document is targeted to an
experienced water resources ArcGIS user who wants to learn how to use the tools. The online help
provides more detail on the way the tools operate.
Objective
In this tutorial, the user will perform drainage analysis on a terrain model. The Arc Hydro tools are
used to derive several data sets that collectively describe the drainage patterns of a catchment. Raster
analysis is performed to generate data on flow direction, flow accumulation, stream definition, stream
segmentation, and watershed delineation. These data are then used to develop a vector representation
of catchments and drainage lines. Using this information, a geometric network is constructed. Utility
of Arc Hydro tools is demonstrated by applying them to develop attributes that can be useful in
hydrologic modeling. To accomplish these objectives, the user is exposed to important features and
functionality of Arc Hydro tools, both in raster and vector environment.
Getting Started
Software Requirements
ArcGIS 8.3 or higher (Note: Arc Hydro is fully functional for ArcInfo and ArcEditor only –
limited functionality is available with ArcView – see note below)
Spatial Analyst extension
XML Parser version 3.0 or 4.0 (MSXML 3.0 or MSXML 4.0) – 4.0 recommended
Water Utilities Application Framework (ApFramework)
Note: Using Arc Hydro with ArcView
The Arc Hydro tools require ArcInfo/ArcEditor 8.3 or higher with the Spatial Analyst extension.
Since ArcView allows only limited editing (simple features), not all functions are available with
ArcView. In particular, the following functions require ArcInfo/ArcEditor:
• Hydro Network Generation
• Calculate Length Downstream for Edges
• Calculate Downstream for Junctions
• Find Next Downstream Junctions
• Store Flow Direction
• Set Flow Direction
September 2005 1Arc Hydro Tools v1.1 Final – Tutorial
The following tables summarize the requirements (ArcEditor/ArcInfo and Spatial Analyst) for each
function in Arc Hydro.
Terrain Preprocessing Requires Requires
ArcInfo/ArcEditor Spatial Analyst
DEM Reconditioning x
Build Walls x
Fill Sinks x
Flow Direction x
Flow Accumulation x
Stream Definition x Segmentation x
Catchment Grid Delineation x
Catchment Polygon Processing x
Drainage Line Processing x
Adjoint Catchment Processing
Drainage Point Processing x
Longest Flow Path for Catchments x Path for Adjoint Catchments x
Slope x
Slope greater than 30 x
Slope greater than 30 and facing North x
Weighted Flow Accumulation x
Terrain Morphology Requires Requires
ArcInfo/ArcEditor Spatial Analyst
Drainage Area Characterization x
Drainage Boundary Characterization x
Drainage Connectivityx x
Watershed Processing Requires Requires
ArcInfo/ArcEditor Spatial Analyst
Batch Watershed Delineation x
Batch Subwatershed Delineation x
Drainage Area Centroid
Longest Flow Path x Path for Watersheds x Path for Subwatersheds x
Construct 3D Line
Smooth 3D Line
Flow Path Parameters from 2D Line eters from 3D Line
September 2005 2Arc Hydro Tools v1.1 Final – Tutorial
Attribute Tools Requires Requires
ArcInfo/ArcEditor Spatial Analyst
Assign HydroID
Generate From/To Node for Lines
Find Next Downstream Line
Calculate Length Downstream for Edges x gth Downstream for Junctions x
Find Next Downstream Junction x
Store Area Outlets
Consolidate Attributes
Accumulate Attributes
Display Time Series
Transfer ID
Transfer Value
Compute Local Parameters x
Compute Global Parameters x
Network Tools Requires Requires
ArcInfo/ArcEditor Spatial Analyst
Hydro Network Generation x
Node/Link Schema Generation
Store Flow Direction x
Set Flow Direction x
Buttons and Tools Requires Requires
ArcInfo/ArcEditor Spatial Analyst
Flow Path Tracing x
Point Delineation x
Batch Point Generation
Assign Related Identifier
Global Point Delineation x
Trace By NextDownID Attribute
September 2005 3Arc Hydro Tools v1.1 Final – Tutorial
Setting up the Arc Hydro Tools
As indicated in the software requirements, the Arc Hydro tools require ArcGIS 8.3 or higher, the
Spatial Analyst extension, XML Parser 3.0 or 4.0, and the Water Utilities Application Framework
(ApFramework). XML Parser 3.0 was already required for the versions of Arc Hydro previously
released – so if you have an older version of Arc Hydro, you should already meet the requirement for
the XML Parser. However we recommend the installation and use of MSXML 4.0 to ensure
compatibility with the Arc Hydro based water resources applications.
Installing XML Parser 4.0
This needs to be done independently from the Arc Hydro installation. MSXML 3.0, that meets the
requirement, should be on your computer if you already had Arc Hydro installed. However, you may
want to upgrade to MSXML 4.0 if you plan to use extensions to Arc Hydro such as GeoRas that
requires 4.0.
Check the version(s) of the XML Parser installed on your computer
Open the registry editor:
• Start\Run…
• Type Regedit in the Run window to open the registry editor
Browse to the following locations in the editor:
• HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Msxml2.DOMDocument\CurVer
(Note: this location indicates the version of the XML Parser that is used by default – if this location
does not exist, then neither MSXML 3.0 nor MSXML 4.0 are installed.)
• HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Msxml2.DOMDocument.3.0
This location exists only if MSXML 3.0 is installed.
• E\Classes\Msxml2.DOMDocument.4.0 exists only if MSXML 4.0
The following table summarizes the actions that are required, depending on the existence/value of
these keys. Again, MSXML 3.0 meets the current Arc Hydro requirements. The upgrade to 4.0 is
optional, but recommended since other Arc Hydro extensions (GeoRas) require 4.0.
September 2005 4Arc Hydro Tools v1.1 Final – Tutorial
Msxml2. Msxml2. Msxml2. Action Required
DOMDocument DOMDocument.3.0 DOMDocument.4.0
Not found – no XML Parser Not found – MSXML 3.0 Not found – MSXML Install 4.0
installed not installed 4.0 not installed
CurVal = Found - MSXML 3.0 Not found Optional upgrade to 4.0:
Msxml2.DOMDocument.3.0 – installed install 4.0 + set CurVal
Default version is 3.0 to 4.0
CurVal = Found - MSXML 3.0 Found - MSXML 4.0 Optional modification of
Msxml2.DOMDocument.3.0 – installed installed default version to 4.0:
Default version is 3.0 set CurVal to 4.0
CurVal = Found or not found Found - MSXML 4.0 None
Msxml2.DOMDocument.4.0 – installed
Default version is 4.0
If you determine that no action is required, then you may proceed to the Arc Hydro install, and skip the
rest of the section.
How to install MSXML 4.0 and make it the default version
This installation is a 3 steps process (the files needed for the install may be downloaded from ESRI ftp
site – see instructions below):
• run msxml.msi, to setup the XML Parser
o if this install fails, then run InstMsiW.exe, to setup the Microsoft installer needed to
install the XML Parser. You may need to reboot your machine after the install. Then
rerun msxml.
• check in the registry that the default version is 4.0 by browsing to the key
HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Msxml2.DOMDocument\CurVer
If data does not point to 4.0 then edit the key by right-clicking on Default, clicking Modify and
editing so that it reads Msxml2.DOMDocument.4.0.
Installing the Water Utilities Application Framework
Once the XML Parser requirement is met, you may proceed with the installation. Arc Hydro needs to
be installed on top of the Water Utilities Application Framework (ApFramework). In previous versions
of Arc Hydro, the framework was installed together with Arc Hydro. It now has its own installation
setup that needs to be run before the Arc Hydro setup. This is the general framework used by Arc
Hydro and other applications such GeoRas or GeoHMS. The Framework files are always installed
September 2005 5Arc Hydro Tools v1.1 Final – Tutorial
under C:\Program Files\ESRI\WaterUtilsCommon\ApFramework or C:\Program
Files\ESRI\WaterUtilsCommon\ApFramework9.
Installing Arc Hydro
Once the Water Utilities Application Framework requirement is met, you may proceed with the
installation of Arc Hydro by running the Arc Hydro setup. The tools are installed by default under
C:\Program Files\ESRI\ArcHydro or C:\Program Files\ESRI\ArcHydro9.
1. Run the Arc Hydro setup
Run the setup, setup.exe, by double-clicking on the file or using Add/Remove Programs.
Note: if a previous version of the Arc Hydro tools is already installed, the following window will be
displayed.
To uninstall the previous version, use the function Add/Remove Programs in the Control Panel, select
Arc Hydro Tools and click Change/Remove. Then follow the instructions from the Wizard to remove
the tools.
Check the location where the tools were installed and make sure it is empty. If some of the Arc Hydro
tools dlls are still in the bin directory (e.g. ArcHydroTools.dll, TimeSeriesManager.dll,
WSHPTools.dll), unregister and delete these files before proceeding with the installation of the new
version.
After double-clicking the setup, browse to the desired installation location: the Arc Hydro files will be
installed in the bin directory under the destination folder: C:\Program Files\ESRI\ArcHydro or
C:\Program Files\ESRI\ArcHydro9.
September 2005 6