readme.txt


                   HydroClimATe - Version: 1.0.0 3/7/2014
                  Hydrologic and Climatic Analysis Toolkit


NOTE: Any use of trade, product or firm names is for descriptive purposes 
      only and does not imply endorsement by the U.S. Government.

The files in this distribution contain HydroClimATe, as documented in:

Dickinson, J.E., Hanson, R.T., and Predmore, S.K., 2014, 
     HydroClimATe—Hydrologic and climatic analysis toolkit: 
     U.S. Geological Survey Techniques and Methods 4–A9, 49 p,
     http://dx.doi.org/10.3133/tm4a9.

The software and related documentation referenced herein were developed by the 
U.S. Geological Survey (USGS) for use by the USGS in fulfilling its mission.  
The software can be used, copied, modified, and distributed without any fee or 
cost. Use of appropriate credit is requested.  The software is provided as a 
minimum in source code form as used on USGS computers.  In many cases, the 
executable runfiles also are provided for these computers.

The USGS provides no warranty, expressed or implied, as to the correctness of 
the furnished software or the suitability for any purpose.  The software has 
been tested, but as with any complex software, there could be undetected errors.  
Users who find errors are requested to report them to the USGS.  The USGS has 
limited resources to assist non-USGS users; however, we make an attempt to fix 
reported problems and help whenever possible.

This version of HydroClimATe is packaged for personal computers using
Microsoft Windows XP, or Windows 7 or 8.

See the file hydroclimate\doc\release.txt for a description of the latest version 
of HydroClimATe.  Instructions for running the program are provided below.


                            TABLE OF CONTENTS

                         A. DISTRIBUTION FILE
                         B. EXTRACTING FILES
                         C. COMPILING
                         D. RUNNING THE EXAMPLE PROBLEMS


A. DISTRIBUTION FILE

The following self-extracting distribution file is for use on personal 
computers:

         hydroclimate_1_0_0.exe

The distribution file contains:

         Source code for HydroClimATe.
         
         Supplementary documentation in text and/or PDF files.
         
         Test data sets for the example applications.


B. EXTRACTING FILES

The distribution file is a self-extracting program.  Execution of the 
distribution file creates numerous individual files.  The extraction program 
allows you to specify the directory in which the files should be restored.  
By default, the files will be extracted into directory C:\WRDAPP.  The following 
directory structure will be created in C:\WRDAPP or in a directory specified at 
the time of extraction:

DIRECTORY                    FILES
---------------------------  ---------------------------------------------------
hydroclimate
|-- bin                      executables for the main application
|-- doc                      documentation files
|-- src                      source code for HydroClimATe
|-- examples                 contains directories for the input files
    |                        for the examples described in the documentation             
    |-- example1             files for example 1
    |-- example2             files for example 2
    |-- example3             files for example 3
    |-- example4             files for example 4

Included in directory hydroclimate\doc are various documentation files.  Some of 
them may be Portable Document Format (PDF) files. The PDF files are readable
and printable on various computer platforms using Acrobat Reader from Adobe.
The Acrobat Reader is freely available from the following World Wide Web sites:
      http://www.adobe.com/
      http://www.shareware.com/

Updates to HydroClimATe will be made available at 
http://water.usgs.gov/ogw/hydroclimate/ 
and will be described in release notes in hydroclimate\doc\release.txt.


C. COMPILING

In general, the requirements for compiling the example applications are a 
C# compiler and the knowledge of using the compiler.


D. RUNNING THE EXAMPLE PROBLEMS

Example data sets are provided to verify that the example applications are 
correctly installed and running on the system.  The test directory contains 
subdirectories that contain test-case input files for the four example
problems described in the documentation.