         OVERVIEW OF THE FIPER MODEL EXAMPLES SET
                           AND
         INSTRUCTIONS FOR HOW TO RUN THE EXAMPLES


OVERVIEW:

This directory contains a set of Fiper example model files,
together with associated simulation codes and data files
needed to run the examples.  The examples have been built
to illustrate a variety of Fiper components, and to show
how to combine them in useful ways.  Each example has been
documented in two ways.  Workflow annotation has been used
to briefly explain what each component does (each model's
annotations are hidden to reduce clutter in the workflow).
More complete explanations are stored in the 'Description'
properties of the components; each root component describes
the example as a whole, while each child component explains
the purpose and function of that component in that example.

NOTE: Fiper components MAY be marked 'Technical Preview'
      when they are first released.  Examples using these
      components will appear in this subdirectory ONLY if
      users have requested that 'Technical Preview' com-
      ponents be provided with their Fiper installation.


These are the main subdirectories:

1) simcodes

   Several examples include one or more Fiper 'simcode' com-
   ponents.  These examples illustrate the ability of Fiper
   to execute external programs and manage their input and
   output files.  This subdirectory contains all external
   programs used by the examples.

   The 'simcodes/src' subdirectory contains the source codes
   (in Fortran, C, etc) for these programs.  They are
   supplied primarily as documentation.  Beneath the 'simcodes'
   subdirectory is a 'bin' directory, which in turn contains
   a subdirectory named for each platform for which Fiper
   is supported.  Each sub-subdirectory contains the actual
   executables for these programs, for that platform.

2) components

   This folder contains a directory for each Engineous core
   component, with models that demonstrate the use of that
   component.

3) approximations

   This folder contains models that demonstrate the use of
   approximation techniques.

4) postprocessing

   This folder contains examples of results post-processing

5) features

   This folder contains models that demonstrate specific
   features of the general product.
 
6) applications

   This folder contains models that show the usage of multiple
   components to form complete applications.

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

GENERAL EXECUTION NOTES:

To run an example (or any Fiper model), you must adjust to
limits in the current Fiper architecture.  In particular,
a Simcode component cannot contain its executable, nor can
an executable be sent across the network to the 'Fiper sta-
tion' on which it will run.  Therefore, the executable for
a Simcode component must reside in an accessible directory
on the machine running the target 'Fiper station', and of
course it must be the platform-specific version of the exe-
cutable for that machine.

If this is done, then the component will be able to locate
that executable if one of two conditions is satisfied:

  a) The directory containing the executable is in the
     %PATH% list of the target 'Fiper station'.  All of
     the Fiper startup scripts add the example simcode
     directory for the current platform to %PATH%.

or

  b) The Simcode component has been edited so that
     the simcode name includes the directory path.

Ideally, the Fiper installation should already do (a) for
you, so you should be able to run each example 'as is'.
If this is not the case, contact your system administrator
and/or call Engineous technical support.


If an example reads a data file, then a File parameter in
the topmost Task component will exist and will contain the
text of an instance of the data file.  You may run the ex-
ample on a different data set by editing this File param-
eter to refer to the file containing that data set.  This
data may be either held in-memory, as for the instance in
the model, or read from an external file.  In the latter
case, the file name entered into the File parameter must
contain the full path to the chosen data file (the %PATH%
list is of no help in this case).


Several of the examples also have non-Simcode components
which must be adjusted before execution.  For instance, if
an example contains a Mail component, address information
must be entered or the component will not run.  These ad-
justments unfortunately cannot be done via the 'Configure
and Run' option; they must be done in the Gateway before
execution.
