ACP3 README

Updated: Tue Jan 27 21:25:30 1998 by Jeff Dalton

ACP3 stands for Air Campaign Planning Process Panel.

This file briefly describes the status of the current release, the
contents of the ACP3 directory (as distributed) and some of the
conventions that are used.

For instructions on how to install and use ACP3, see the file
INSTALL in this directory.


Major parts of ACP3
-------------------

    +------------------+    +------------------+    +------------------+
    |                  |    |                  |    |                  |
    | KQML Watcher     |    | Process Models   |    | Viewers          |
    |                  |    |                  |    |                  |
<-->|                  |--->|                  |--->|    Graph View    |
    | KQML to Process- |    | Workflow Stepper |    |    Matrix View   |
    | Step Mapper      |    | Process State    |    |    Info Panel    |
    |                  |    |                  |    |                  |
    +------------------+    +------------------+    +------------------+


Status as of this release
-------------------------

Graph and Matrix Views are available.  The viewers are driven from
structures that could be loaded from the Process Models module, and
there is a dynamic visual state interface that could be driven by
Workflow Stepper and Process State module.

Process Models are loaded directly into the Graph Viewer from files (as a
surrogate for a simple library) created by a process editor editor based
on the Graph Viewer.

The Process Models and Process State and Workflow Stepper modules
(ie, those in the middle box) do not yet exist.

A simple initial version of the KQML Watcher is included in version
0.4 for integration tests with MPA's PCMs.  This version makes a KQML
connection to the TIE 97-1 demonstration framework, and monitors for
two simple process steps.  These two steps are directly translated
into process status calls directly to the Viewers.

The KQML-to-process-step mapping functions are partially implemented
but are not used within version 0.4.


Subdirectories and their contents
---------------------------------

  bin/

     Various executables, including shell scripts for running Java
     programs.

  doc/

     Documentation of various sorts.  See doc/README.

  doc/javadoc/

     Documentation produced by javadoc, usually via "make javadoc".

  html/

     HTML files that correspond to the run-time information displays,
     together with any included images.

  IMG/

     Images used at run-time by ACP3.

  kqml/

     The Java KQML code used by ACP3.  The actual files are in
     kqml/java-src.  kqml/lib/kqml.jar is what's normally put in the
     CLASSPATH.  It is a symbolic link to kqml.jar in kqml/java-src.
     This version was obtained from Terry Padgett on 23 Jan 1998.

  oplan/

     The oplan package.  By convention, this directory contains only
     subpackages and files (such as Release.java) that apply to the
     the oplan package as a whole.

  oplan/acp3/

     The oplan.acp3 package -- classes specific to ACP3.

  oplan/op3/

     The oplan.op3 package -- classes relevant to process panels
     generally.  This package is currently empty.

  oplan/test/

     The oplan.test package.  This contains a number of simple main
     programs used to test various aspects of the system, features of
     Java, etc.

  oplan/util/

     The oplan.util package -- general-purpose classes, not specific
     to process panels.

  ProcessModels/

     Saved process models.


Web Page Supporting ACP3
------------------------

http://www.aiai.ed.ac.uk/~arpi/ACP3 is a web page which supports the
different releases of ACP3.  It contains the distributed system
itself, instructions on installation and use, background information,
associated publications, and sample screen images.  In future
releases, there will be a demonstration (an applet) that can be run
from a web-browser.