==================================================================
Quick configure, build and install hints for Trilinos
==================================================================

:Author: Brent Perschbacher
:Contact: bmpersc@sandia.gov

:Abstract: This document is intended to be a very concise set of examples of
how to configure, build and install Trilinos. The intended audience is those
who need a quick refresher on Trilinos CMake build system or those wanting a
quick install without worrying about all the features and options that are
available.  For a more indepth document on what features and options are
available and how to use them, see the document:

    doc/build_ref/TrilinosBuildReference.html

(or the *.rst or *.pdf forms).

.. sectnum::

.. contents::


Requirements
============

CMake 2.8.11 or newer
A C and C++ compiler
Optionally a Fortran compiler
Optionally an installation of MPI


Instructions
============

Following are a few examples of simple configurations for Trilinos. Anything in
<> should be replaced with the appropriate path or value and excluding the <>.

It is recommended that you put your configure options in a script so you can
repeat the configure if necessary.

Note: all examples assume a unix like command line and Makefile Generators.


Simple MPI instructions (enables most packages)
------------------------------------------------

cmake \
-DTPL_ENABLE_MPI=ON \
-DMPI_BASE_DIR=<path to mpi install> \
-DTrilinos_ENABLE_ALL_PACKAGES=ON \
-DCMAKE_INSTALL_PREFIX=<path to install Trilinos into> \
<path to Trilinos source>

make -j<n> install


Simple serial instructions (enables most packages)
--------------------------------------------------

cmake \
-DCMAKE_C_COMPILER=<path to C compiler> \
-DCMAKE_CXX_COMPILER=<path to C++ compiler> \
-DCMAKE_Fortran_COMPILER=<path to Fortran compiler> \
-DTrilinos_ENABLE_ALL_PACKAGES=ON \
-DCMAKE_INSTALL_PATH=<path to install Trilinos into> \
<path to Trilinos source>

make -j<n> install


Intermediate MPI instructions (enables a few packages)
------------------------------------------------------

cmake \
-DTPL_ENABLE_MPI=ON \
-DMPI_BASE_DIR=<path to mpi install> \
-DTrilinos_ENABLE_Epetra=ON \
-DTrilinos_ENABLE_AztecOO=ON \
-DTrilinos_ENABLE_Ifpack=ON \
-DCMAKE_INSTALL_PATH=<path to install Trilinos into> \
<path to Trilinos source>

make -j<n> install


Intermediate MPI instructions (enables a few packages)
------------------------------------------------------

cmake \
-DCMAKE_C_COMPILER=<path to C compiler> \
-DCMAKE_CXX_COMPILER=<path to C++ compiler> \
-DCMAKE_Fortran_COMPILER=<path to Fortran compiler> \
-DTrilinos_ENABLE_Epetra=ON \
-DTrilinos_ENABLE_AztecOO=ON \
-DTrilinos_ENABLE_Ifpack=ON \
-DCMAKE_INSTALL_PATH=<path to install Trilinos into> \
<path to Trilinos source>

make -j<n> install


Useful Options
==============

To disable Fortran use the following
-DTrilinos_ENABLE_FORTRAN=OFF

To enable a package
-DTrilinos_ENABLE_<package name>=ON

To enable tests
-DTrilinos_ENABLE_TESTS=ON

To enable all Primary Stable Trilinos packages (not all packages)
-DTrilinos_ENABLE_ALL_PACKAGES=ON
