source: trunk/README @ 1105

$Id: README 1078 2008-02-12 21:45:24Z jari $

Copyright (C) 2003 Jari Häkkinen, Peter Johansson
Copyright (C) 2004 Jari Häkkinen
Copyright (C) 2006 Jari Häkkinen, Peter Johansson
Copyright (C) 2007 Peter Johansson
Copyright (C) 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.


If you checked out this project from the subversion repository you
must run './bootstrap' to initialize the build system. Now do
'./configure' to create the Makefiles. Optionally you can run
configure with '--enable-debug', which will turn on debug options. If
you want to disable debugging options do './configure CXXFLAGS=""',
needed since autoconf defaults to adding debug flags to the compiler.

Issue 'make' to compile the project.

Optionally you can do 'make check' to run test programs. 'make doc'
will generate documentation.

'make install' will install the package into your system. 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.

Contact information through http://trac.thep.lu.se/yat


= Requirements =

== quiet nan ==

Quiet NaN's must be supported.

== BLAS ==

A C implementation of Basic Linear Algebra Subprograms (cBLAS) is
required. GSL comes with a reference implementation, but you should
consider getting a hardware optimized implementation. ATLAS provides
optimized BLAS (see below).

== GSL ==

GNU Scientific Library, GSL http://www.gnu.org/software/gsl/.


= Optional packages =

== ATLAS ==

GSL supplies a reference implementation of BLAS. You may want to
consider using hardware optimized BLAS. The ATLAS
(http://math-atlas.sourceforge.net/) 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. 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:

  #> LDFLAGS="/usr/lib64/atlas" ./configure

=== doxygen ===

=== latex ===

=== dvipdfm ===

=== latex2html ===