Notes on setting up Proteus (V3.01 and above)

The only files you need are:
	proteus-V*.tar.Z   (one file)
	userdoc*.tar.Z     (one file)
	overview.ps.Z

The primary file will "detar" into a proteus-V3 directory with the following
structure:

proteus-V3
    augment : contains the source code for augment
        libc : source code for cycle-counted version of libc
            printf : source code for printf and variants
        libm : source code for cycle-counted version of libm
    bin : executables (should be on path)
    catoc : source code for catoc (preprocessor)
    engine : source for the Proteus engine
    lib : target directory for cycle-counted libraries
    saveparams : source code for utility that encodes parameter files
		 into the executable at compile time


Once the directories are created, run the INSTALL program in the
proteus-V3 directory.  It will build the executables and libraries.
Next, make sure that the bin subdirectory in on your path and edit
the SimMake file in bin to set the LIBDIRS variable to point to the
directory containing the cycle-counted libraries (normally the lib
subdirectory). (INSTALL will remind you about these last two steps.)

The master copy is now set up.  Each user (perhaps each application)
should have their own Proteus directory, which contains a copy of the
engine code.  To set up a Proteus directory, 1) create a directory,
say <xxx>, wherever you want it, and 2) run "install-proteus <xxx>" to
instantiate a copy of Proteus in that directory.  

install-proteus is located in the bin subdirectory and will have to be
edited before it can be run correctly (if not it will tell you it
needs to be edited).  The csh variable "default_dir" must be
initialized to point to the proteus-V3/engine directory of the master
copy (not the proteus-V3 directory itself).  Comments inside
install-proteus describe this process in more detail. install-proteus
sets up symbolic links to the engine code to save space; these files
are read only so there should not be a safety problem.  All of the
files that the user is expected to change are copied into the
directory.

Once instantiated into a user's directory, Proteus is ready to run.
The default application is 8-queens running on an 8x8 mesh.  To try
the example applications, just copy then into a user's directory
(which will overwrite existing UserMake and *.param files).


Eric A. Brewer
February 25, 1993
