README.TXT


                    RECESS - Version: 2.0 (March 2012)
      A COMPUTER PROGRAM FOR ANALYSIS OF STREAMFLOW RECESSION

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

This version of RECESS is packaged for personal computers using the
Microsoft Windows operating system. An executable file for personal
computers is provided as well as the source code.  The source code can
be compiled to run on other computers.
                         

A. DISTRIBUTION FILE

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

          RECESS.exe

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.  The default installation directory is C:\WRDAPP.  You
have the opportunity to specify an alternate installation directory
during extraction of the software. The following directory structure
will be created in the installation directory:

 |--RECESS
    |--documentation              : Documentation reports 
    |--programs_and_sample_data   : RECESS, SCREEN, CURV, RECPLOT 
                                      programs and sample data
    |--source_codes               : Source codes for RECESS, SCREEN, CURV,
                                      AND RECPLOT
    

Program SCREEN is a utility program that displays the period of streamflow
record to identify months that have complete and incomplete streamflow records.
Program RECPLOT is used to display recession segments while the user is executing 
RECESS and program CURV is used to display the Master Recession Curve (MRC).


B. DOCUMENTATION

The documentation subdirectory contains three documentation reports for the program.
The first, wri98-4148.pdf, is the original report providing a complete
explanation of the program (Rutledge, 1998). The second, UserManualRECESS.pdf,
describes use of the report with the streamflow data sets provided in the
programs_and_sample_data subdirectory. Users should familiarize themselves with 
both reports before running the software. 


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 site:
      http://www.adobe.com/


C. VERSION HISTORY

RECESS was initially released in 1993 and updated in 1998 (Rutledge, 1998). The
code was further modified in 2003 and 2007 to accommodate changes in the way
USGS streamflow data were written to data files. The current version of the 
code (2.0) was updated in February 2012 to extend the maximum number of years
of analysis from 120 to 150 (extending through 2041).


D. EXECUTING RECESS, SCREEN, and CURV

Each of the programs has been compiled using the Intel Visual Fortran 9.0 
CompilerBuild Environment for 32-bit applications for Windows. The compiled
programs are located in the programs_and_sample_data subdirectory with the 
sample data sets.

The programs can be run by double-clicking either of them. A DOS Window will then
be opened and the user should follow the requested information.


E. COMPILING

Although executable versions of the program are provided, the source
codes also are provided in the source_codes subdirectory so that they can
be recompiled if necessary. However, the USGS cannot provide assistance
to those compiling the programs. In general, the requirements are a Fortran
compiler and the knowledge to use the compiler.


F. REFERENCES

Rutledge, A.T., 1998, Computer programs for describing the recession of 
ground-water discharge and for estimating mean ground-water recharge and
discharge from streamflow records--update: U.S. Geological Survey Water-
Resources Investigations Report 98-4148, 43 p.