Cactus Code Thorn PAPI
Authors    : Tom Goodale
CVS info   : $Header$
--------------------------------------------------------------------------

Purpose of the thorn:

This thorn uses the Performance API available from

http://icl.cs.utk.edu/projects/papi

to collect performance data about a cactus run.

Description:

Currently it uses the 'perfometer' library to connect to a gui
and to display the MFLOP/s of the code.

Optionally it marks the different evolution time bins with different
colours.

Usage:

In parameter file:

To activate just include 'papi' in the ActiveThorns parameter.

To switch of colour marking, set

PAPI::mark = "no"

There are parameters which control the colours, these are

default_colour
initial_colour
prestep_colour
evol_colour
poststep_colour
analysis_colour

The allowed colours are

  "default"
  "black" 
  "blue" 
  "cyan"
  "darkGray"
  "gray"
  "green"
  "lightGray"
  "magenta"
  "orange"
  "pink"
  "red"
  "white"
  "yellow"

as these are all the current perfGUI knows about.

At runtime:

The code will stop saying something like

    Perfometer server awaiting connection on port # 3545

At this point you should start the performance GUI (perfGUI) 
available from the PAPI project, and tell it to connect to the machine
you are running cactus on.