The latest version of this document is always available at http://tfel.sourceforge.net/install.html.

It refers to the current development sources, instructions for specific released versions are included with the sources and detailled in the INSTALL and the INSTALL-cmake files located at the root directory of the sources).

This document describes the generic installation procedure for TFEL from the sources on posix-compliant systems. Please note that the main systems on which TFEL was developed is Linux. Extensive testing on other posix-compliant operating systems, notably FreeBSD, is lacking, although compilation and unit testing is known to work.

The installation on Windows plateform is described here

The creation of binary packages are detailled here

TFEL is known to work on standard architectures implemented by the Intel and AMD processors, either 32 or 64 bits. As no specific instructions relative to the underlying architecture is used in the code, other architectures shall work as well.

If you have cmake (version greater than \(2.8\)) installed on your system, installing ̀TFEL` basically boils down to the following simple commands:

$ cmake [options]
$ make 
$ make install

If you do not have cmake, you can use the standard procedure

$ configure [options]
$ make 
$ make install

The optional parameters of cmake and configure allows you to:

The rest of this document is dedicated to giving all the details related to the installation process. For completeness, we will broke the installation procedure into five steps:

Prerequisites

Compilers

TFEL version 2.0 requires a C++-98 compliant compiler, a C compiler and optionally a fortran compiler. The following compilers suite are officially supported:

Third party libraries

TFEL has been designed to have no dependencies to third parties libraries to the very exception of the Boost.Python library used to create the optional bindings for the Python language.

Third party tools

The better way to build the TFEL is to use the cmake build system (see this section). We only support cmake version greater than \(2.8\).

To build TFEL documentation, one may need:

Downloading the source

Official releases sources can be downloaded on TFEL sourceforge page (see the Download entry of the navigation bar).

Sources of the development version are accessible through CEA svn servers (see the Contributing page for details).

Configuration

TFEL supports two build-systems:

Creating a build directory

We highly recommend to use a separate directory to build the sources.

In the following, we use the following convention:

Both $srcdir and $prefix must contain an absolute path.

Using the cmake build system

The use of the cmake build system is described in depth in the INSTALL-cmake file that is located in the top directory of TFEL sources. We only support cmake version greater than \(2.8\), so please check the version available on your system:

$ cmake --version

A typical usage of cmake is the following:

$ cmake $srcdir -DCMAKE_BUILD_TYPE=Release -Dlocal-castem-header=ON -Denable-fortran=ON -Denable-aster=ON -DCMAKE_INSTALL_PREFIX=$prefix

This will build TFEL with the support of interfaces for the Cast3M and Code-Aster finite element solvers.

Various other options can be passed to cmake:

Some default compiler settings are detected by cmake, depending on your system. To explicitly specify the compilers to be used, one may define one of the following variables:

For example, we can use the following command to select the Intel compilers suite:

$ CXX=icpc CC=icc FC=ifort F77=ifort cmake $srcdir -DCMAKE_BUILD_TYPE=Release -Dlocal-castem-header=ON -Denable-fortran=ON -Denable-aster=ON -DCMAKE_INSTALL_PREFIX=$prefix

Controlling the generation of the documentation

Generation of the documentation can be controlled by the following options:

Localisation of the libraries

Some LiNuX distributions install libraries in lib64 on \(64\) bits architectures and in lib. This can be changed by defining a LIB_SUFFIX variable like this:

$ cmake -DLIB_SUFFIX=64 ....

Using the configure script

$ $srcdir/configure --enable-fortran --enable-aster --enable-tests --enable-local-castem-header --prefix=${prefix}

This will build TFEL with the support of interfaces for the Cast3M and Code-Aster finite element solvers.

Various other options can be passed to the configure script:

Some default compiler settings are detected by configure, depending on your system. To explicitly specify the compilers to be used, one may define one of the following variables:

For example, we can use the following command to select the Intel compilers suite:

$ CXX=icpc CC=icc FC=ifort F77=ifort $srcdir/configure --enable-fortran --enable-aster --enable-tests --enable-local-castem-header --prefix=${prefix}

Building

The configuration step created a compilation environment based on the make tool.

To build TFEL libraries and binaries, just type:

$ make

To reduce compilation times, one may want to build TFEL libraries and binaries in parallel. In this case, just type:

$ make -j X

X being the number of processors available.

Testing (optional)

TFEL is delivered with many unit tests (more than 500 if you are using the cmake build system and all the interfaces available). To build them and execute them, just type:

$ make check

Again, compilation time can be reduced using the -j option of the make command.

Building the documentation

If a valid LaTeX distribution is available, reference manuals can be build through:

$ make doc-pdf

If the doxygen tool is available, code source documentation can be build through:

$ make doc-html

If pandoc is build and if you are using the cmake build system, the previous command will also install a local version of the TFEL web site.

$ make website

All the documentation will be build with the following command:

$ make doc

Final install

To install TFEL binaries and libraries in the directory pointed by $prefix, just type:

$ make install

Using cmake, the previous command will install the documentation if build.

If you are using the autotools build system, the installation of the documentation is a separate process done by one of the following commands:

$ # install the reference manual
$ make doc-pdf-install
$ # install the doxygen manual
$ make doc-html-install
$ # install all the available documentation
$ make doc-install

Note that you can not build the TFEL website using the autotools build system.

Windows MINGW