source: trunk/README @ 1435

$Id: README 1424 2008-08-20 19:12:21Z peter $


= Compiling =

 1. If you checked out this project from the subversion repository you
    must run '`bootstrap`' to initialize the build system.
 2. Issue '`./configure`' to create the Makefiles. Optionally run
    configure with '`--enable-debug`', which will turn on debug
    options.
 3. Compile with '`make`'.
 4. Optionally do '`make check`' to run test programs.
 5. '`make doc`' will generate documentation.
 6. 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`'.

If you keep your working copy up to date with the repository you must
issue 'autoreconf' in the yat root directory when 'configure.ac' is
updated.


= 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 libtool and
sed since these are normally available.

== Required packages ==

=== GSL ===

GNU Scientific Library, [http://www.gnu.org/software/gsl/ GSL] version
1.8 or later.

=== BLAS ===

A C implementation of Basic Linear Algebra Subprograms
([http://www.netlib.org/blas BLAS]) is required. GSL comes with a
reference implementation, but you should consider getting a hardware
optimized implementation. ATLAS provides optimized BLAS (see below).

=== Boost ===

[http://www.boost.org Boost] version 1.33 or later.

=== 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
[http://math-atlas.sourceforge.net/ 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 ===

[http://www.doxygen.org/ Doxygen] 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://trac.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

This file is part of yat library, http://trac.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 2 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
USA.
}}}