README for SaVi distribution
============================
# $Id: README,v 1.2 2002/04/20 20:13:27 lloydwood Exp $

SaVi is software written to facilitate the visualization and analysis
of satellite constellations.  This software is freely and publicly
available.  We request that any images produced by the software
credit SaVi and The Geometry Center.

Copyright (c) 1995-1997 by The Geometry Center.
See the textfile COPYRIGHT for full details.

The original authors can be contacted at: savi@geom.umn.edu
The current maintainer can be reached at: L.Wood@surrey.ac.uk

See the SaVi webpages:

http://www.geom.umn.edu/locate/SaVi
http://savi.sourceforge.net/
http://www.ee.surrey.ac.uk/Personal/L.Wood/software/SaVi/

Known bugs and possible future features of SaVi are discussed
in the textfile BUGS.



REQUIREMENTS
============

SaVi requires:

 - an ANSI C compiler 
   - most recently tested with gcc 2.96 (egcs variant)

 - Tcl and Tk
   - most recently tested with Tcl/Tk 8.3;
     Likely to work with anything from Tcl/Tk 7.4/4.0 onwards,
     although 8.x gives increased performance.


SaVi has been successfully compiled and run on the following machines
and operating systems:

 - Intel x86 / Linux (Red Hat 6.x, 7.0)
 - Sun SPARC / Solaris (2.4 and later)
 - SGI / Irix5



SaVi can be run as a stand-alone program, or as an "external module"
for the Geomview program.  The latter mode enables three-dimensional
visualization of the satellite constellations, but also needs
the Geomview program.

SaVi can optionally use:

 - Geomview 
   - most recently tested with Geomview 1.8.x.
     Geomview 1.6 or later is needed for texture mapping.

Geomview, like SaVi, was originally available from the Geometry Center:
	http://www.geom.umn.edu/software/download/geomview.html

Geomview is now maintained by Geometry Technologies;
	http://www.geomview.org/
        http://geomview.sourceforge.net/



INSTALLATION INSTRUCTIONS
=========================


For the remainder of this file, we shall refer to the directory
originally containing this file, the root of the SaVi tree, as $SAVI.


1.) In $SAVI/src/Makefile_defs.ARCH, where ARCH is one of linux, sun, or irix,
    you may need to edit some variables to suit your system.  If everything
    is in its usual place, the generic defs file called "Makefile_defs." may
    work perfectly.  If not, choose the file most suitable for your system and:

	- edit the variables that give the locations of the
		tcl/tk libraries and include files.

	- edit the variables that point to the X11 libraries and
		include files.

	- set the CC variable to an ANSI C compiler, e.g. gcc

2.) Type e.g. "make ARCH=linux" (or sun, or irix) in the topmost
    $SAVI directory. Typing just 'make' uses the default
    Makefile_defs. file.

3.) You may need to alter the location of the Tcl and
    Tk libraries in $SAVI/savi at the TCL_LIB and TK_LIB lines
    if linking dynamically.



RUNNING THE SOFTWARE
====================

We shall refer to the directory containing this file as $SAVI.

1.) To run SaVi as a module within Geomview, for 3D rendering,
    when in the $SAVI directory start up Geomview:

	geomview

    and then select "SaVi" from Geomview's scrollable list of external
    modules.  Or invoke directly:

	geomview -run ./savi

    Or from any directory where you can start Geomview, try

	geomview -run $SAVI/savi

2.) To run SaVi standalone, without needing Geomview;
    in the $SAVI directory type:

	./savi

    Or from any other directory,

	$SAVI/savi

3.) To make SaVi accessible to other users, you can copy the "savi"
    script in $SAVI to some directory in other users' search 
    paths such as /usr/local/bin, so they needn't add SaVi's own 
    directory to their own path.  If you do, edit the "savi" script, 
    inserting the full path name of $SAVI as indicated in 
    the script itself:

# If you move this script away from the SaVi installation then
# you should uncomment the following line
#SAVI=/usr/local/savi
# and replace /usr/local/savi with the location of the SaVi installation.

    You can also make SaVi accessible from Geomview's scrollable list of
    external modules.  Assuming Geomview is installed in 
    /usr/local/Geomview, say:

   	cd /usr/local/Geomview/modules/sgi

    Create a file here called ".geomview-savi" containing e.g.:

        (emodule-define  "SaVi"  "/usr/local/savi12/savi")

    where the right-hand side is the absolute path name for the savi 
    script.



VERSION HISTORY
===============

1.2. This development brings together a variety of contributions
     in a single package, 2001.

1.1  Diverse versions with various modifications, not widely released, 1999.

1.0. First public release of SaVi binaries and source code, 1997.



ACKNOWLEDGEMENTS
================

Martin Lo, Polly Estabrook and David Bell at 
NASA's Jet Propulsion Lab inspired the SaVi project.

Patrick Worfolk and Robert Thurman created the SaVi project
while at the Geometry Center, with support from the Geometry Center
technical staff, especially Stuart Levy, Lori Thomson and Nicolas Vera.

Gregory LaCoste contributed coverage interval decay and other code to
the SaVi project.

Lloyd Wood contributed simulations of commercial constellations and
other code to the SaVi project, and now maintains SaVi at SourceForge.

