Skip to content

Latest commit

 

History

History
69 lines (55 loc) · 5.74 KB

INSTALL.md

File metadata and controls

69 lines (55 loc) · 5.74 KB
Raw

synopsis

$ git clone https://github.com/TESSEorg/ttg.git
$ cmake -S ttg -B ttg/build -DCMAKE_INSTALL_PREFIX=/path/to/ttg/install [optional cmake args]
$ cmake --build ttg/build
(optional, but recommended): $ cmake --build ttg/build --target check-ttg
$ cmake --build ttg/build --target install

prerequisites

TTG is usable only on POSIX systems.

mandatory prerequisites

  • CMake, version 3.14 or higher
  • C++ compiler with support for the C++17 standard, or a more recent standard. This includes the following compilers:
  • one or more of the following runtimes:
    • PaRSEC: this distributed-memory runtime is the primary runtime intended for high-performance implementation of TTG
    • MADNESS: this distributed-memory runtime is to be used primarily for developmental purposes

While the list of prerequisites is short, note that the runtimes have many more mandatory prerequisites; these are discussed under transitive prerequisites below. Also: it is strongly recommended that the runtimes are built as parts of the TTG build process (this requires some of the optional prerequisites, listed below). This will make sure that the correct versions of the runtimes are used.

optional prerequisites

  • Git 1.8 or later: needed to obtain the source code for PaRSEC or MADNESS runtimes
  • Boost version 1.66 or later: needed to use TTG with classes serializable by the Boost.Serialization library.
    • The Boost.Serialization library is not header-only, i.e., it must be compiled.
    • If the Boost package is not detected TTG can download and build Boost as part of its build process; to do that configure TTG with the CMake cache variable TTG_FETCH_BOOST set to ON (e.g., by adding -DTTG_FETCH_BOOST=ON to the CMake executable command line)
    • Note to package maintainers: TTG also requires Boost.CallableTraits; if Boost is not found or built, TTG installs and uses a bundled copy of Boost.CallableTraits. To avoid the installation and use of the bundled Boost.CallableTraits configure TTG with the CMake cache variable TTG_IGNORE_BUNDLED_EXTERNALS set to ON.
  • (Doxygen, version 1.8.12 or later: needed for building documentation

transitive prerequisites

PaRSEC

see here

MADNESS

  • An implementation of Message Passing Interface version 2 or 3, with support for MPI_THREAD_MULTIPLE.
  • a Pthreads library
  • (optional) Intel Thread Building Blocks (TBB), available in a commercial or an open-source form

prerequisites for building examples

TTG includes several examples that may require additional prerequisites. These are listed here:

  • SPMM: (block-)sparse matrix multiplication example
    • Eigen library, version 3
    • BTAS library: for the block-sparse case only
      • BTAS' prerequisites are listed here

build

  • configure: cmake -S /path/to/ttg/source/directory -B /path/to/ttg/build/directory <cmake args>
  • build+test: cmake --build /path/to/ttg/build/directory --target check-ttg
  • generate HTML dox: cmake --build /path/to/ttg/build/directory --target html-ttg
  • install: cmake --build /path/to/ttg/build/directory --target install

useful cmake cache variables:

Variable Default Description
BUILD_TESTING ON whether target check-ttg and its relatives will actually build and run unit tests
TTG_EXAMPLES OFF whether target check-ttg and its relatives will actually build and run examples; setting this to ON will cause detection of several optional prerequisites, and (if missing) building from source
TTG_ENABLE_TRACE OFF setting this to ON will enable the ability to instrument TTG code for tracing (see ttg::trace(), etc.); if this is set to OFF, ttg::trace() is a no-op
TTG_FETCH_BOOST OFF whether to download and build Boost automatically, if missing
TTG_IGNORE_BUNDLED_EXTERNALS OFF whether to install and use bundled external dependencies (currently, only Boost.CallableTraits)