--------------------------------------------------------------------------------
                                    Manifest

This directory contains the following:

1. README                         this file
2. COPYRIGHT_NOTICE               the copyright notice file
3. pltmg_single (directory)       source code, single precision version
4. pltmg_double (directory)       source code, double precision version      
5. journal_files (directory)      journal files for use with example problems
6. quick_ref (directory)          quick reference guide
7. guide.pdf                      complete documentation
                      
--------------------------------------------------------------------------------
                                  Installation

The PLTMG package is provided in single and double precision versions in the
directories pltmg_single and pltmg_double, respectively. Each directory 
contains the following files:

 1. pltmg.f                         most source code
 2. mgmpi.f                         MPI interface 
 3. mgvio.f                         SG interface
 4. xgui.c                          X-Windows interface
 5. mgxdr.c                         XDR interface
 6. atest.f                         main driver program
 7. battery.f, burger.f circle.f,   
    control.f, domains.f, ident.f,
    jcn.f, message.f, mnsurf.f,     sample test problem data sets
    naca.f, ob.f, square.f, usmap.f
 8. xgui_stubs.c,                   (mostly) empty routines 
    mgvio_stubs.f, mgmpi_stubs.f  
 9. Makefile_generic,               a simple generic makefile
    Makefile_linux,                 an example makefile for Linux
    Makefile_osx                    an example makefile for Apple OS X

Your environment must include Fortran and C compilers as well as X-Windows,
MPI, and SG. The X-Windows GUI is based on the Motif widget set and X11R6.
SG (socket graphics) is an OpenGL display tool written by Michael Holst;
SG and its supporting package MALOC are available at http://fetk.org .

All calls to X-Windows routines are made by routines in the file xgui.c.
If X-Windows is unavailable, empty replacement routines in the file
xgui_stubs.c can be used in place of xgui.c. (e.g. set X11_INTERFACE to
xgui_stubs in the Makefile). In this case, X-Windows libraries are not 
needed to resolve external references, but the X-Windows interface is disabled.

Similarly, if SG is not available or not desired, one can use the file
mgvio_stubs.f in place of mgvio.f. Then the maloc library is not needed 
to resolve external references, and the SG and bh file graphics interfaces 
are disabled. Finally, if MPI is not available or not desired, use 
mgmpi_stubs.f in place of mgmpi.f. This removes the need to load the 
mpi library to resolve external references, and the parallel processing 
capabilities of PLTMG are disabled.

To make an executable, you must compile pltmg.f, mgmpi.f, mgvio.f,
mgxdr.c, xgui.c, atest.f, and your test problem data set, and link the 
resulting object files with the Xm, Xt, and X11 libraries (X-Windows),
the maloc library (SG) and the mpi library (MPI). A generic Makefile
is provided (along with sample Makefiles for linux and osx). To use the 
Makefile, specify paths for the indicated include files and libraries, and
set compiler flags as necessary.

The double precision files were generated from the single precision files
using the package S2D by Jim Meyering, available from Netlib.

--------------------------------------------------------------------------------
                                  SG Interface

To use the SG (OpenGL) interface in PLTMG, first start up one or more
(up to 4) SG display tools. Click on the button marked `socket' and choose
INET TCP/IP Socket K, where K=0,1,2,3. Be sure each instance of SG is 
associated with a unique socket number. Choose the corresponding socket
number for graphics output (PLTMG parameters FDEVCE, GDEVCE, JDEVCE, MDEVCE).
If SG is running on a different computer from PLTMG, be sure to set the PLTMG
parameter SGHOST to the name of the host machine (default is `localhost').

--------------------------------------------------------------------------------
                                  Documentation

The directory quick_ref contains minimal documentation in the form of
HTML files which can be viewed using Firefox or similar browser. Complete
documentation is provided in the PDF file guide.pdf.

The quick reference guide was generated from LaTeX files using the package 
LaTeX2HTML by Nikos Drakos and Ross Moore.

--------------------------------------------------------------------------------
                                    Thanks

This version of PLTMG was supported by the National Science Foundation
through grant DMS-0511766 (University of California at San Diego).
The UCSD Scicomp Beowulf cluster was built using funds
provided by the National Science Foundation through SCREMS grant 0532073.

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




.