README

This is the PHISH package for streaming data analysis.

PHISH stands for Parallel Harness for Informatics Stream Hashing.

Copyright (2012) Sandia Corporation.  Under the terms of Contract
DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains
certain rights in this software.  This software is distributed under
the Berkeley Software Distribution (BSD) License.

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

PHISH is a simple, portable library which, along with a setup script
bait.py, allows you to hook together a collection of independent
stand-alone programs so that they can collectively process streaming
or archived data and compute something of interest by sending datums
to each other.  The PHISH backend can use either the MPI or ZMQ
(socket) libraries to perform message passing.

The authors of the code are Steve Plimpton and Tim Shead, who can be
emailed at sjplimp@sandia.gov and tshead@sandia.gov.  The PHISH WWW
Site at www.sandia.gov/~sjplimp/phish.html has more information about
the code and its uses.

This PHISH distribution includes the following files and directories:

README			   this file
LICENSE			   the BSD License
bait			   tool to process and launch PHISH input scripts
doc			   documentation
example 		   simple PHISH scripts
minnow			   stand-alone programs which link to the PHISH library
mpionly                    MPI-only benchmark programs
python			   Python wrapper on PHISH library
src			   PHISH library source files

Point your browser at doc/Manual.html to get started.