-----------------------------------------------------------------------------
Waves Toolbox for ArcGIS 10.0/10.1

Scripts originally developed by David Finlayson
-----------------------------------------------------------------------------
     Operational Geologist 
     USGS Pacific Science Center 

     Copyright 2004, 2005 David Finlayson, Some Rights Reserved

     This Toolbox and all of its components are licensed for use under a
     Creative Commons License. Details about the specific rights granted to you
     under this license can be found at the following URL:

     http://creativecommons.org/licenses/by-nc-sa/3.0/

-----------------------------------------------------------------------------

These scripts were updated by Jason Rohweder

U.S. Geological Survey
Upper Midwest Environmental Sciences Center
La Crosse, WI 54603 USA
jrohweder@usgs.gov

October 2012
-----------------------------------------------------------------------------

Waves provides scripts to estimate Wind fetch and several wave outputs including
Significant Wave Height, Wave Length, Spectral Peak Wave Period, Maximum Orbital 
Wave Velocity, and Shear Stress according to the U.S. Army Corps of Engineers
Shore Protection Manual and Coastal Engineering Manual.

USACE, 1984.  Shore Protection Manual, Coastal Engineering Research Center, Fort 
Belvoir, Virginia.

USACE, 2002, Coastal Engineering Manual, Engineer Manual 1110-2-1100, U.S. Army 
Corps of Engineers, Washington, D.C. (in 6 volumes).
  

REQUIREMENTS:

ArcGIS 10.0 or more recent
- A Spatial Analyst License
- Python 2.4 or more recent
- win32all (Python Windows extensions, see trouble shooting section below)

INSTALLATION:

1) copy the directory Waves to a suitable location.
2) Open ArcMap 10.0/10.1 and activate ArcToolbox (Windows -> ArcToolbox)
3) Right-click inside the ArcToolbox panel and select Add Toolbox...
4) Open the folder Waves and click on the Waves toolbox icon.

You should now be ready to run the wind fetch and wave scripts.

GETTING STARTED:

Read the help documentation for each tool by right-clicking on the script and
selecting help. 

TROUBLE SHOOTING:

Problem: While running your script, It is bailing out with an error similar to this:

Error in executing: cmd.exe ...

Failed to execute ...


Solution: Install the win32all extensions to Python (also called pywin32). They can
be found here:

 http://sourceforge.net/projects/pywin32/files/pywin32/

It turns out that if you use the Windows installer from Python.org you will only get the
platform neutral version of Python. To get the Windows-only extensions you need the
win32all package by Mark Hammond. This allows Python to communicate with COM
servers such as ArcGIS, Excel, Word etc. Python scripting in ArcGIS cannot work without
this extension.


also, a scratch workspace must be designated using the Environments button.  It 
is suggested that the user select a workspace (folder) for this parameter and not 
use a geodatabase as is sometimes suggested in the ArcGIS literature.  There have 
been issues with the model not operating when a geodatabase or an invalid workspace 
was selected.


