source: branches/0.4-stable/README @ 1298

Last change on this file since 1298 was 1284, checked in by Jari Häkkinen, 15 years ago

Added comment on document installation.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.7 KB
[2]1$Id: README 1284 2008-04-23 10:33:23Z jari $
[1262]4= Compiling =
[1262]6 1. If you checked out this project from the subversion repository you
7    must run '`bootstrap`' to initialize the build system.
8 2. Issue '`./configure`' to create the Makefiles. Optionally run
9    configure with '`--enable-debug`', which will turn on debug
10    options.
11 3. Compile with '`make`'.
[1284]12 4. Optionally do '`make check`' to run test programs.
13 5. '`make doc`' will generate documentation.
14 6. Issue '`make install`' to install the package on your system,
15    documentation will not be installed if documentation was not
16    generated above. Default installation location is `/usr/local`,
17    this can be changed with
18    '`./configure --prefix=/dir/to/install/to`'.
[953]20If you keep your working copy up to date with the repository you must
21issue 'autoreconf' in the yat root directory when '' is
25= Requirements =
[1262]27Except for the obviously needed C++ compiler there are a few packages
28and programs required for compiling yat and generate supporting
29material. The configure script will look for required programs and
30report failure to meet the requirements. Here we list some of the
31requirements, but omit required standard utilities such as libtool and
32sed since these are normally available.
[1262]34== Required packages ==
[1262]36=== GSL ===
[1262]38GNU Scientific Library, [ GSL] version
391.6 or later.
[1262]41=== BLAS ===
[1262]43A C implementation of Basic Linear Algebra Subprograms
44([ BLAS]) is required. GSL comes with a
45reference implementation, but you should consider getting a hardware
46optimized implementation. ATLAS provides optimized BLAS (see below).
[1262]48=== quiet nan ===
[1262]50Quiet NaN's must be supported.
[1262]52== Optional packages ==
[1262]54=== ATLAS ===
[1059]56GSL supplies a reference implementation of BLAS. You may want to
[1262]57consider using hardware optimized BLAS. The
58[ ATLAS] software provides an
59automatic hardware optimized BLAS library.
61The detection of ATLAS is supported by the yat configuration script
62but in many cases the ATLAS libraries are installed in
[1262]63non-conventional directory locations. As an example, on Fedora 8,
64ATLAS libraries are
[1059]65located in /usr/lib/atlas or /usr/lib64/atlas depending on your
66hardware architecture. If you have ATLAS installed and the configure
67script fails to locate it, try to add the location to the atlas
[1078]68libraries when running configure:
[1180]70  #> LDFLAGS="-L/usr/lib64/atlas" ./configure
[1262]72=== Doxygen ===
[1272]74[ Doxygen] is required for generation of the
[1262]75API documentation
[1272]77= Documentation =
[1272]79The API documentation for the latest release is availabe in PDF and
80HTML and can be found through If you wish
81to build a local copy, issue `make doc` and you will find the
82documents in directory `doc/`.
86Copyright (C) 2003 Jari Häkkinen, Peter Johansson
87Copyright (C) 2004 Jari Häkkinen
[1275]88Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
90This file is part of yat library,
92The yat library is free software; you can redistribute it and/or
93modify it under the terms of the GNU General Public License as
94published by the Free Software Foundation; either version 2 of the
95License, or (at your option) any later version.
97The yat library is distributed in the hope that it will be useful, but
98WITHOUT ANY WARRANTY; without even the implied warranty of
100General Public License for more details.
102You should have received a copy of the GNU General Public License
103along with this program; if not, write to the Free Software
104Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
Note: See TracBrowser for help on using the repository browser.