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

PECOS: Parallel Environment for Creation Of Stochastics 

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

Michael S. Eldred
Richard V. Field, Jr.
Eric    T. Phipps
Clayton G. Webster

Sandia National Laboratories
P.O. Box 5800, Mail Stop 1318
Albuquerque, NM 87185-1318

Email: pecos-developers@dev.sandia.gov

------------------------------------------------------------------------------
License.

PECOS is distributed under the GNU General Public License.  It is free 
software; you can redistribute it and/or modify it under the terms of the GNU 
General Public License as published by the Free Software Foundation; either 
version 2 of the License, or (at your option) any later version.  A copy of 
this license is included in the LICENSE file, and is also available online 
from http://www.gnu.org/copyleft/gpl.html.  Also refer to the COPYRIGHT file 
for important U.S. Government legal notices.

The PECOS distribution contains libraries which are available separately
under compatible licensing terms.  In particular, many of the libraries in
packages are available separately under the GNU General Public License (GPL)
or Lesser General Public License (LGPL).

------------------------------------------------------------------------------
Overview.

PECOS generates samples of random fields (RFs) and stochastic processes (SPs)
from a set of user-defined power spectral densities (PSDs).  The RF/SP may 
be either Gaussian or non-Gaussian and either stationary or nonstationary, 
and the resulting sample is intended for run-time query by parallel finite 
element simulation codes.

Refer to http://www.cs.sandia.gov/PECOS for additional information.

------------------------------------------------------------------------------
Distribution.

The directories contained in this distribution include:

packages            Libraries for fft (fftw) and vector/matrix utilities
                    (teuchos).

docs                The Users Manual is maintained here.  Other references
		    are available from the PECOS Web site
		    (http://www.cs.sandia.gov/PECOS).

src                 The main source code repository for the PECOS system.

test                Files for regression and unit testing of the PECOS system.

------------------------------------------------------------------------------
Installation.

The installation procedure uses a standard GNU installation based on autoconf.
The basic steps are to invoke 'configure' to generate Makefiles for your 
particular system and then invoke 'make' to compile the sources.  See the 
INSTALL file for detailed instructions.

------------------------------------------------------------------------------
Platforms.

This package is actively supported with nightly build and regression test 
verifications on the following platforms for the given operating systems, 
C++ compilers, and MPI libraries:

  PC        RHEL 4 Update 5          g++ v3.4.6           MPICH IP/GM/IB

  SUN       Solaris 2.10             CC v5.7              SUNWhpc

  IBM       AIX 5.2                  xlC v7.0             POE MPI

Ports to the following platforms are supported manually on an as-needed basis:

  PC        Windows (Cygwin 1.5.11)  g++ 3.3.3            MPICH

  Mac       OS X 10.3.5              g++ 3.3              MPICH

  Red Storm                          PGI                  Cray MPI

  PC        Linux                    Intel                OpenMPI, MVAPICH

------------------------------------------------------------------------------
Versions.

Versions of the PECOS software have been tagged as follows:

Version-1-0         x/xx/xx

------------------------------------------------------------------------------
Contributing enhancements.

PECOS is both a research and a production code and is the subject of active
continuing development.  Bug reports, suggestions for improvement, and required 
changes for other platforms/compilers are welcome.  Direct messages to
pecos-developers@dev.sandia.gov.

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