/*******************************************************************
 *                                                                 *
 *  PETE build and installation instructions for Unix platforms    *
 *                           Version 2.0                           *
 *                                                                 *
 *******************************************************************
 *    For release notes, see README.                               *
 *    For licensing information, see LICENSE.                      *
 *    For the people who created PETE, see CREDITS.                *
 *    For a tutorial on using PETE, open html/index.html in your   *
 *        web browser.                                             *
 *    For more information, including updates and new releases,    *
 *        see http://www.acl.lanl.gov/pete                         *
 *    For help, reporting bugs, and making suggestions, please     *
 *        send e-mail to pete@acl.lanl.gov                         *
 *******************************************************************/

                      SUPPORTED COMPILERS:
                      --------------------

PETE version 2.0 had been tested on the following platforms and
compilers:

    - SGI IRIX 6.X with the Kuck and Associates KCC compiler
     (v3.3e or later)
    - SGI IRIX 6.X with SGI C++ 7.2.1 (patched) or later compiler
    - Linux, with the Kuck and Associates KCC compiler
     (v3.3e or later)

We were able to compile about half the examples with a recent
developer snapshot of the EGCS compiler.

More information about the compilers above can be obtained from
the following URLs:

        Cygnus Solutions (EGCS):    http://egcs.cygnus.com
        Kuck and Associates (KCC):  http://www.kai.com
        Silicon Graphics (SGI C++): http://www.sgi.com

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

                BEFORE YOU START TO COMPILE PETE:
                ---------------------------------

You should notice the following files/folders inside of the
pete-2.0 folder:

   CREDITS ....................... the people who developed PETE
   examples ...................... sample PETE programs
   config ........................ makefiles for several compilers
   html .......................... HTML documentation for PETE
   INSTALL.unix .................. this file
   LICENSE ....................... the licensing terms for PETE
   README ........................ general information and release notes
   src ........................... the PETE source code

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

               UNIX BUILD/INSTALL INSTRUCTIONS:
               --------------------------------

PETE is a very simple package.  To use PETE, you typically only need to
include the header file src/PETE/PETE.h, and an additional header file
created by the tool found in src/Tools.  Read the tutorial and article
in the html directory to get a feel for how to use PETE.  The following
instructions tell you how to build the tool, build the example codes,
and how to install PETE in a central location.

1. Select which architecture and compiler you wish to use.  Several
   configuration files are listed in the config/ directory,
   for various unix platforms and compilers  (currently LINUXKCC,
   SGI64CC, SGI64KCC, and SGI64EGCS).
   Pick the appropriate file for your system.
   If none are appropriate, then either modify one that is close, or
   copy one and modify it.  The configuration file needs to specify
   the c++ compiler (CXX), compiler arguments for building the tool
   (CXXARG), and compiler arguments that cause adequate inlining for
   expression templates to be efficient (CXXOPTARG).  Optionally, you
   can also provide an architecture specific subdirectory name (PETEARCHDIR)
   for use in installing the tool.

2. Set the environment variable PETEARCH to the name of the configuration
   file you chose from step 1.  For example, if you used config/SGI64CC,
   set PETEARCH to SGI64CC.

3. At the top-level PETE directory, run 'make'.  The default target builds
   the tools.  (You could also change to the src/Tools directory and type
   'make' there.)

4. From the top-level PETE directory:
   To build the example codes, type 'make example'.  To run all the example
   codes, type 'make run'.  To remove all the examples and the tool, type
   'make clean'.


5. (optional) To install PETE in a central location, set the environment
   variable PETEDIR to the location you wish to install PETE.  From the
   top-level PETE directory type 'make install'.  You should build
   the tool (step 3) before installing PETE.  Several of the examples
   (examples/DDJ, examples/Mixed, and examples/Vector) contain a 'Makefile.user'
   that illustrates how to use PETE from its installed location.  (The default
   makefiles use the tool and header files in the source tree in which they
   are located.)

6. The html/ directory contains a tutorial (index.html), an article submitted
   to Doctor Dobb's Journal (ddj_article.html), and a man page for the
   MakeOperators tool (makeoperators.html).

