CUMULVS version 1.1.0:
       Computational Steering, Interactive Visualization
    and Application-Directed Fault Tolerance / Checkpointing
            in High-Performance Scientific Applications
            Oak Ridge National Laboratory, Oak Ridge TN.
       Authors:  James Arthur Kohl and Philip M. Papadopoulos
                    (C) 1996-2000 All Rights Reserved

                               NOTICE

  Permission to use, copy, modify, and distribute this software and
  its documentation for any purpose and without fee is hereby granted
  provided that the above copyright notice appear in all copies and
  that both the copyright notice and this permission notice appear
  in supporting documentation.

  Neither the Institution, Oak Ridge National Laboratory, nor the
  Authors make any representations about the suitability of this
  software for any purpose.  This software is provided ``as is''
  without express or implied warranty.

  CUMULVS was funded by the U.S. Department of Energy.

=======================================================================

CUMULVS is an infrastructure library that allows a programmer to
easily extract data from a running parallel simulation and send the
data to a visualization package.  CUMULVS includes the capability to
steer user-defined parameters in a distributed simulation.  CUMULVS
can also perform user-directed checkpointing and restarts of parallel
programs across a heterogeneous network.  The interface is kept as
simple as possible.  The programmer merely defines the decomposition
of parallel data and the number and types of scalar parameters, and
CUMULVS does the rest.  It supports the simultaneous viewing of
multiple dynamically attached front-end visualization programs, or
viewers.  A single interface routine handles the attachment and
detachment protocols, the selection and sending of data, and updating
steering parameters.  CUMULVS allows each viewer to interactively
select the granularity and extent of data that it desires to see.
This allows the user to effectively visualize large datasets without
exhausting the available network bandwidth.  The visualization and
checkpointing features of CUMULVS are independently applicable.

=======================================================================

Using CUMULVS:

1.  To create the base distribution of CUMULVS, you will first need to
install the following additional software packages:

	* PVM 3.3.11 or later.

2.  Next, you will need to set the STV_ROOT environment variable in
your $HOME/.cshrc or equivalent shell startup file.  The value of
$STV_ROOT should be the directory where you have installed CUMULVS,
as in:

	setenv STV_ROOT /home/me/CUMULVS

3.  Once this has been accomplished, you can compile the CUMULVS
libraries and examples by running "make" in the $STV_ROOT directory.

=======================================================================

Files:
------

Makefile - main CUMULVS makefile for compiling libraries and examples.

README - this file.

avs/ - directory of AVS visualization-related files, including the
	AVS viewer module "stv_viewer".

examples/ - directory of example programs for use with CUMULVS,
	including the sample text-only viewer, the Tcl/Tk slicer
	viewer, and the particle-based "FLYME" simulation (helicopter
	game).

include/ - directory of public CUMULVS header files for user
	applications and viewer programs.

src/ - directory containing the source for the CUMULVS libraries.

=======================================================================

Porting Notes:
--------------

For Cray T3E using Cray PVM 3.3.10 for UNICOS:
1. setenv PVM_GROUPS_FULL 1
2. setenv PVM_PE_LIST all
3. Modify the CUMULVS/src/Makeincl.mp.PVM to work with Cray's PVM:
	A. Select alternate definitions for STV_MP_M4FILE and
		STV_MP_CONFFILE, to use configuration files provided
		in "$(STV_ROOT)/src/conf/".
	B. Select the alternate definition for STV_XDIR, so that
		executables will go into the $(HOME)/pvm3 executables
		directory instead of $PVM_ROOT.
	C. Clear the definitions for STV_PVM_GLIB, STV_PVMGLIB and
		STV_FPVMLIB, as the functions these represent are all
		included in the single Cray PVM library.

=======================================================================

Correspondence:
---------------

Mail any questions, problems or suggestions to the authors at:

	cumulvs@msr.epm.ornl.gov

Also check the CUMULVS Web Page for announcements, information
and the latest version of the user's guide, at:

	http://www.csm.ornl.gov/cs/cumulvs.html

Good Luck!  :-)