$Id$

=============================================================================
=============================================================================

HPCToolkit/README

As of August 17, 2015, the Rice HPCToolkit repositories (hpctoolkit,
hpcviewer, libmonitor) have moved to GitHub.

https://github.com/HPCToolkit

To clone the hpctoolkit repository:

git clone https://github.com/HPCToolkit/hpctoolkit.git

More directions to appear on the HPCToolkit web site:

http://hpctoolkit.org

=============================================================================
=============================================================================

Contents:
  0. What is HPCToolkit
  1. Obtaining and Installing HPCToolkit
  2. For More Information

=============================================================================

----------------------------------------
0. What is HPCToolkit
----------------------------------------

HPCToolkit is an integrated suite of tools for measurement and
analysis of program performance on computers ranging from multicore
desktop systems to the nation's largest supercomputers. HPCToolkit
provides accurate measurements of a program's work, resource
consumption, and inefficiency, correlates these metrics with the
program's source code, works with multilingual, fully optimized
binaries, has very low measurement overhead, and scales to large
parallel systems. HPCToolkit's measurements provide support for
analyzing a program execution cost, inefficiency, and scaling
characteristics both within and across nodes of a parallel system.

More information can be found at
  http://hpctoolkit.org.


=============================================================================

----------------------------------------
1. Obtaining and Installing HPCToolkit
----------------------------------------

Basic information for obtaining and installing HPCToolkit may be found in
  README.Install

Detailed information about obtaining and installing HPCToolkit may be
found at:
  WWW:   http://www.hpctoolkit.org/software.html
  Local: <hpctoolkit-source>/doc/www/software.html


=============================================================================

----------------------------------------
2. For More Information
----------------------------------------

WWW Page:
  [www]   http://hpctoolkit.org
  [local] <hpctoolkit-install>/share/doc/hpctoolkit/index.html

Documentation:
  [www]   http://hpctoolkit.org/documentation.html
  [local] <hpctoolkit-install>/share/doc/hpctoolkit/documentation.html

  N.B.: See especially the "Quick Start" chapter of the Users Manual.

Man pages:
  <hpctoolkit-install>/share/man

Command-line help:
  Pass -h or --help to any of HPCToolkit's command-line tools for a
  help message.

Email (for compliments, complaints and cash):
  hpctoolkit-forum =at= rice.edu

  N.B.: When contacting us or submitting a bug report, please tell us
  about the following:
  - System. E.g., operating system, architecture, PAPI, compiler.
  - HPCToolkit. E.g., version; build information from
    <hpctoolkit-build>/config.log, which is generated after running
    configure.
  - Profiled application: E.g., language, whether dynamically or
    statically linked.
  - Relevant profiling/analysis commands. If you have used hpcrun,
    please include the results of executing:
      hpcsummary --all <hpctoolkit-measurements>

----------------------------------------
3. ComDetective
----------------------------------------

A tool for inter-thread/inter-core communication analysis based on HPCToolkits.
A paper about it is published at SC 2019: Sasongko, M.A. , Unat, D., Pakhtar, P., and Chabbi, M "ComDetective: A Lightweight Communication Detection Tool for Threads."

Installation
===============
See ComDetective.Install

Usage
=====
See ComDetective.HowToRun