Skip to content

Commit 34da6b5

Browse files
committed
Merge pull request #1 from wslack/patch-1
Update Readme
2 parents 880aa5a + a549bea commit 34da6b5

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README renamed to README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
STAT: the Stack Trace Analyasis Tool
1+
## STAT: the Stack Trace Analysis Tool
22
http://paradyn.org/STAT/STAT.html
33

4-
Please see LICENSE for usage terms.
4+
Please see [LICENSE](https://github.com/LLNL/STAT/blob/master/LICENSE) for usage terms.
55

6-
1. OVERVIEW
6+
### OVERVIEW
77
The Stack Trace Analysis Tool (STAT) is a highly scalable, lightweight tool that gathers and merges stack traces from all of the processes of a parallel application to form call graph prefix trees. STAT generates two prefix trees termed 2D-trace-space and 3D-trace-space-time. The 2D-trace-space prefix tree is a merge of a single stack trace from each task in the parallel application. The 3D-trace-space-time prefix tree is a merge of several stack traces from each task gathered over time. The latter provides insight into whether tasks are making progress or are in a hang state (livelock, deadlock, infiite loop, etc.). The call graph prefix trees also identify processes equivalence classes, processes exhibitin similar behavior with respect to their call paths. A representative task from each equivalence class can then be fed into a full-featured debugger for root cause analysis at a manageable scale.
88

99
STAT's source code also includes STATBench, a tool to emulate STAT. STATBench enables the benchmarking of STAT on arbitrary machine architectures and applications by fully utilizing parallel resources and generating artificial stack traces.
1010

11-
2. BUILDING STAT
11+
### BUILDING STAT
1212
STAT has several dependent libraries that must be installed:
13-
-MRNet
14-
-LaunchMON
15-
-GraphLib
16-
-Stackwalker
17-
-libdwarf
13+
* MRNet
14+
* LaunchMON
15+
* GraphLib
16+
* Stackwalker
17+
* libdwarf
1818

1919
In addition, the STAT GUI requires Python with PyGTK, both of which are commonly preinstalled with many Linux operating systems.
2020

2121
Please refer to INSTALL for instructions on building STAT
2222

23-
3. SUPPORTED PLATFORMS
23+
### SUPPORTED PLATFORMS
2424
STAT is able to run on any machine where all of the dependent libraries run. This currently includes:
25-
-IBM BlueGene/L
26-
-IBM BlueGene/P
27-
-IBM BlueGene/Q
28-
-x86-based architectures with SLURM
29-
-x86-based architectures with OpenMPI
30-
-Cray XT
31-
-Cray XE
32-
-Cray XK
33-
34-
4. CONTACT
35-
Please direct any questions to Gregory Lee <[email protected]>
25+
* IBM BlueGene/L
26+
* IBM BlueGene/P
27+
* IBM BlueGene/Q
28+
* x86-based architectures with SLURM
29+
* x86-based architectures with OpenMPI
30+
* Cray XT
31+
* Cray XE
32+
* Cray XK
33+
34+
### CONTACT
35+
Please direct any questions to [Gregory Lee](mailto:[email protected]).

0 commit comments

Comments
 (0)