source:
trunk/README
@
2066
| Last change on this file since 2066 was 2066, checked in by , 14 years ago | |
|---|---|
|
|
| File size: 5.4 KB | |
$Id: README 2066 2009-09-16 17:47:43Z peter $
About yat
This directory contains the yat library. For an overview of the project, visit
Configuring and building yat
- If you checked out this project from the subversion repository you
must run '
bootstrap' to initialize the build system. - Issue '
./configure' to create the Makefiles. Optionally run configure with '--enable-debug', which will turn on debug options. - Compile with '
make'. - Optionally do '
make check' to run test programs. - '
make doc' will generate documentation. - Issue '
make install' to install the package on your system, documentation will not be installed if documentation was not generated above. Default installation location is/usr/local; this can be changed with './configure --prefix=/dir/to/install/to'.
The configure script has additional options; ./configure --help
will offer you those choices or refer to Requirements below.
Requirements
Except for the obviously needed C++ compiler there are a few packages and programs required for compiling yat and generate supporting material. The configure script will look for required programs and report failure to meet the requirements. Here we list some of the requirements, but omit required standard utilities such as echo and sed since these are normally available.
Required packages
GSL
GNU Scientific Library, GSL version
1.8 or later. If you have GSL installed in a non-standard location,
./configure --with-gsl-prefix=DIR can be useful to provide the
location of GSL. The gsl-config script, which is used to retrieve
needed compiler and linker flags, is expected to be found in
DIR/bin/.
BLAS
A C implementation of Basic Linear Algebra Subprograms (BLAS) is required. GSL comes with a reference implementation, but you should consider getting a hardware optimized implementation. ATLAS provides optimized BLAS (see below).
The configure script searches for many different BLAS libraries in a
specific order (for details refer to m4/yat_cblas.m4). If you want
to use a specific CBLAS library, ./configure --with-cblas=LIB may be
useful. Note, however, that the chosen/detected CBLAS library is not
hard-coded into the installed libyat, but a user can choose a
different CBLAS when she links her application. A way to access which
CBLAS was detected during the configuration is to access the
yat-config script directly or via the autoconf macros included in the
distribution. If you do want to hard-code a choice of CBLAS into the
installed libyat, you may provide the appropriate value to LIBS. The
following line, for example:
#> ./configure LIBS=-lcblas
will hard-code the choice of -lcblas into the libyat.
Boost
Boost version 1.33 or later. If you have Boost
installed in a non-standard location, ./configure --with-boost=DIR
can be useful to provide the location of Boost. Boost header files are
expected to be found in DIR/include.
quiet nan
Quiet NaN's must be supported.
infinity
infinity for type double must be supported.
Optional packages
ATLAS
GSL supplies a reference implementation of BLAS. You may want to consider using hardware optimized BLAS. The ATLAS software provides an automatic hardware optimized BLAS library.
The detection of ATLAS is supported by the yat configuration script but in many cases the ATLAS libraries are installed in non-conventional directory locations. As an example, on Fedora 8, ATLAS libraries are located in /usr/lib/atlas or /usr/lib64/atlas depending on your hardware architecture. If you have ATLAS installed and the configure script fails to locate it, try to add the location to the atlas libraries when running configure:
#> ./configure LDFLAGS="-L/usr/lib64/atlas"
Doxygen
Doxygen 1.5 (or newer) is required for generation of the API documentation. Doxygen uses a number of applications, epstopdf, latex, makeindex, and pdflatex. If any of these applications are missing, generation of API documentation is disabled.
Documentation
The API documentation for the latest release is availabe in PDF and
HTML and can be found through http://dev.thep.lu.se/yat. If you wish
to build a local copy, issue make doc and you will find the
documents in directory doc/.
Developers
See file README.developer for developer specific information.
Copyright (C) 2003 Jari Häkkinen, Peter Johansson Copyright (C) 2004 Jari Häkkinen Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson Copyright (C) 2009 Peter Johansson This file is part of yat library, http://dev.thep.lu.se/yat The yat library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. The yat library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with yat. If not, see <http://www.gnu.org/licenses/>.
