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

This directory contains the following:

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

The pltmg_source directory contains the following files:

 1. mg0.f                           module that sets precision
 2. pltmg.f                         most source code
 3. mgmpi.f, mgmpi_stubs.f          MPI interface 
 4. webgui.c                        web browser interface
 5. atest.f                         main driver program
 6. battery.f, box.f, burger.f 
    circle.f, control.f, domains.f, 
    ident.f, jcn.f, message.f,      sample test problem data sets
    mnsurf.f, naca.f, ob.f, 
    square.f, usmap.f
 7. Makefile                        a simple generic makefile
    Makefile_ubuntu                 an example makefile for Linux
    Makefile_osx                    an example makefile for Apple OS X

Your environment must include Fortran90 and C compilers as well MPI.
You can set the precision in the module mthdef in the file mg0.f. This
module is machine dependent, but should work as provided in most
environments. Set the floating point arithmetic to single, double, or
quadruple precision as desired. (The default is double precision).
Set the integer size to single or double. (The default is single).

To make an executable, you must compile mg0.f, pltmg.f, mgmpi.f, webgui.c 
atest.f, and your test problem data set, and link the resulting object files 
with 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, libraries, and compilers, and set compiler flags as 
necessary. Note that compilers might require the option -pthread to
successfully compile and link webgui.c.

If MPI is not available or not desired, use mgmpi_stubs.f in place of mgmpi.f. 
mgmpi_stubs.f contains mostly empty versions of all the MPI interface routines,
and removes the need to load the mpi library to resolve external references.
However, all parallel processing capabilities of PLTMG are disabled.

--------------------------------------------------------------------------------
                                  WEBGUI Interface

The web browser interface was written by Chris Deotte, and is a direct
replacement for both the SG and X-Windows interfaces found in earlier versions
of the PLTMG package. webgui.c creates a web server on the local machine
running pltmg, and communicates with any standard web browser via an internet
socket. Thus the web browser can reside on the local machine or a remote 
machine. Although it was designed with the PLTMG software package in mind, 
webgui.c is an independent application that can be used to create a web browser 
based graphical user interface for any Fortran or C software package.

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

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

The quick reference guide was generated from LaTeX files using the package 
tth by Ian Hutchinson.

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

This version of PLTMG was supported by the National Science Foundation
through grants DMS-1318480 and DMS-1345013 (University of California at 
San Diego). The UCSD Scicomp Beowulf cluster was built using funds
provided by the National Science Foundation through MRI-0821816.

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