source: trunk/README @ 1487

Last change on this file since 1487 was 1487, checked in by Jari Häkkinen, 13 years ago

Addresses #436. GPL license copy reference should also be updated.

  • 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: 4.0 KB
RevLine 
[2]1$Id: README 1487 2008-09-10 08:41:36Z jari $
2
[573]3
[1262]4= Compiling =
[573]5
[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`'.
[1303]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`'.
[573]19
[953]20If you keep your working copy up to date with the repository you must
21issue 'autoreconf' in the yat root directory when 'configure.ac' is
22updated.
[848]23
[1059]24
25= Requirements =
26
[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.
[1059]33
[1262]34== Required packages ==
[1059]35
[1262]36=== GSL ===
[1059]37
[1262]38GNU Scientific Library, [http://www.gnu.org/software/gsl/ GSL] version
[1287]391.8 or later.
[1059]40
[1262]41=== BLAS ===
[1059]42
[1262]43A C implementation of Basic Linear Algebra Subprograms
44([http://www.netlib.org/blas BLAS]) is required. GSL comes with a
45reference implementation, but you should consider getting a hardware
46optimized implementation. ATLAS provides optimized BLAS (see below).
[1059]47
[1325]48=== Boost ===
49
50[http://www.boost.org Boost] version 1.33 or later.
51
[1262]52=== quiet nan ===
[1059]53
[1262]54Quiet NaN's must be supported.
[1059]55
[1353]56=== infinity ===
57
58infinity for type double must be supported.
59
[1262]60== Optional packages ==
[1059]61
[1262]62=== ATLAS ===
63
[1059]64GSL supplies a reference implementation of BLAS. You may want to
[1262]65consider using hardware optimized BLAS. The
66[http://math-atlas.sourceforge.net/ ATLAS] software provides an
67automatic hardware optimized BLAS library.
[1059]68
69The detection of ATLAS is supported by the yat configuration script
70but in many cases the ATLAS libraries are installed in
[1262]71non-conventional directory locations. As an example, on Fedora 8,
72ATLAS libraries are
[1059]73located in /usr/lib/atlas or /usr/lib64/atlas depending on your
74hardware architecture. If you have ATLAS installed and the configure
75script fails to locate it, try to add the location to the atlas
[1078]76libraries when running configure:
[1059]77
[1424]78  #> ./configure LDFLAGS="-L/usr/lib64/atlas"
[1059]79
[1262]80=== Doxygen ===
[1059]81
[1442]82[http://www.doxygen.org/ Doxygen] 1.5 (or newer) is required for
83generation of the API documentation. Doxygen uses a number of
84applications, epstopdf, latex, makeindex, and pdflatex. If any of
85these applications are missing, generation of API documentation is
86disabled.
[1262]87
[1272]88= Documentation =
[1262]89
[1272]90The API documentation for the latest release is availabe in PDF and
[1437]91HTML and can be found through http://dev.thep.lu.se/yat. If you wish
[1272]92to build a local copy, issue `make doc` and you will find the
93documents in directory `doc/`.
[1262]94
[1368]95= Developers =
96
[1371]97See file README.developer for developer specific information.
[1368]98
[1262]99----------------------------------------------------------------------
100{{{
101Copyright (C) 2003 Jari Häkkinen, Peter Johansson
102Copyright (C) 2004 Jari Häkkinen
[1275]103Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
[1262]104
[1437]105This file is part of yat library, http://dev.thep.lu.se/yat
[1262]106
107The yat library is free software; you can redistribute it and/or
108modify it under the terms of the GNU General Public License as
[1486]109published by the Free Software Foundation; either version 3 of the
[1262]110License, or (at your option) any later version.
111
112The yat library is distributed in the hope that it will be useful, but
113WITHOUT ANY WARRANTY; without even the implied warranty of
114MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
115General Public License for more details.
116
117You should have received a copy of the GNU General Public License
[1487]118along with yat. If not, see <http://www.gnu.org/licenses/>.
[1262]119}}}
Note: See TracBrowser for help on using the repository browser.