--------------------
OVERVIEW
--------------------

The goal of the Component Based Tool Framework (CBTF) project is to create a community
tool infrastructure that provides individual tool building components to allow others
to add or replace modules, to integrate parts into their own tools, or to customize
existing solutions. In other words, the CBTF project provides support for creating a
compatible interface for components, finding compatible components and defining an
interface API which facilitates communication between components. In the CBTF framework,
a component is defined as a “black box” entity with zero or more inputs and zero or more
outputs. You may connect these components into component networks both distributed and
non-distributed. The CBTF transport mechanism, based on MRNet, allows distributed tools
to automatically become highly scalable.

There are four CBTF sub-projects that are represented by their corresponding
source repositories that comprise the high level CBTF project:

   * CBTF project contains the base code for CBTF that supports creating components,
component networks and the support to connect these components and component
networks into sequential and distributed network tools.

   * CBTF Krell project contains the Krell Institute contributions to the CBTF project.
These contributions include many performance data collectors and support libraries
as well as some example tools that drive the data collection at HPC levels of scale.
This is a fundamental, base portion of the OpenSpeedShop performance tool.

   * CBTF Argo Navis project contains the CUDA collector and supporting libraries that
was done as a result of a DOE SBIR grant and is currently being developed via a NASA
phase II SBIR.

   * CBTF LANL project contains a memory tool and data center type system command monitoring tool.


--------------------
NOTES ON BUILDING
--------------------

# Use a version of cmake: 2.8.12 or greater.
# if not installed by default on the build system.
module load cmake

An example cmake run script is as follows:

$ cat run_cmake_cbtf_lanl.sh
rm -rf build_lanl
mkdir build_lanl
pushd build_lanl

export CC=gcc
export CXX=g++

export KRELL_ROOT=/opt/krellroot_v2.2.2
export CBTF_ROOT=/opt/cbtf_v2.2.2
export CBTF_KRELL_ROOT=/opt/cbtf_v2.2.2
export CBTF_LANL_ROOT=/opt/cbtf_v2.2.2

cmake .. \
        -DCMAKE_BUILD_TYPE=None \
        -DCMAKE_CXX_FLAGS="-g -O2" \
        -DCMAKE_C_FLAGS="-g -O2" \
        -DCMAKE_INSTALL_PREFIX=${CBTF_LANL_ROOT} \
        -DCMAKE_PREFIX_PATH=${KRELL_ROOT} \
        -DMRNET_DIR=${KRELL_ROOT} \
        -DCBTF_DIR=${CBTF_ROOT} \
        -DCBTF_KRELL_DIR=${CBTF_KRELL_ROOT}

make clean
make
make install


Build by doing: sh ./run_cmake_cbtf_lanl.sh