*************Overview*************

The Stream Graph is something of a clone of P4V's native streams viewer, and it started life as test bed with which to prototype new tools.  It is a JavaScript applet that runs in two different settings: Perforce's P4V client, and the open source standalone application called ClientKit.

Currently it's got three interesting sets of functionality that can be launched by context-clicking a stream in the stream graph:

1) The Change Flow diagram.  This allows the user to visually track a particular changelist as it flows through a set of streams (in P4V and ClientKit).

2) The Timeline.  This diagram shows the user all changes for a set of streams, and describes when and where copies and merges happened (in P4V and ClientKit).

3) gitStreams.  This is a visual representation of the git-p4 bridge which shows git repositories connected to Perforce streams.  It allows the user to more easily create git repos off of Perforce streams (works only in ClientKit).

*************Setup*************

As mentioned above, the Stream Graph can be run in both P4V and ClientKit.  The setup is different for each.

Running Stream Graph in P4V:
The process of running the Stream Graph in P4V is the same as running any other applet in P4V.  You'll need to enable applets (you can do this from P4V's Preferences dialog), then create and point to a central settings file that points to p4vIndex.html.  Details on how to do this can be found at http://www.perforce.com/perforce/doc.current/manuals/p4jsapi/index.html

Once you've got it set up, go to the View menu in P4V and you should see Stream Layout Graph.  Click on it and the applet will appear as a tab on the right.

Running Stream Graph in ClientKit:
After you've acquired ClientKit from the public depot, read it's readme file for ClientKit for an explanation of how to use it to run applets.  In this case you'll want to use the Stream Graph project's ckIndex.html (rather than p4vIndex.html).


*************Caveats*************

Both the Change Flow and the Timeline are data-intensive.  If you've got a large set of changelists to look at, it's going to take a long time to load either of these tools.