source: trunk/README @ 1327

Last change on this file since 1327 was 1325, checked in by Peter, 14 years ago

adding info on boost

  • 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
RevLine 
[2]1$Id: README 1325 2008-05-24 04:07:42Z peter $
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
[1262]56== Optional packages ==
[1059]57
[1262]58=== ATLAS ===
59
[1059]60GSL supplies a reference implementation of BLAS. You may want to
[1262]61consider using hardware optimized BLAS. The
62[http://math-atlas.sourceforge.net/ ATLAS] software provides an
63automatic hardware optimized BLAS library.
[1059]64
65The detection of ATLAS is supported by the yat configuration script
66but in many cases the ATLAS libraries are installed in
[1262]67non-conventional directory locations. As an example, on Fedora 8,
68ATLAS libraries are
[1059]69located in /usr/lib/atlas or /usr/lib64/atlas depending on your
70hardware architecture. If you have ATLAS installed and the configure
71script fails to locate it, try to add the location to the atlas
[1078]72libraries when running configure:
[1059]73
[1180]74  #> LDFLAGS="-L/usr/lib64/atlas" ./configure
[1059]75
[1262]76=== Doxygen ===
[1059]77
[1272]78[http://www.doxygen.org/ Doxygen] is required for generation of the
[1262]79API documentation
80
[1272]81= Documentation =
[1262]82
[1272]83The API documentation for the latest release is availabe in PDF and
84HTML and can be found through http://trac.thep.lu.se/yat. If you wish
85to build a local copy, issue `make doc` and you will find the
86documents in directory `doc/`.
[1262]87
88----------------------------------------------------------------------
89{{{
90Copyright (C) 2003 Jari Häkkinen, Peter Johansson
91Copyright (C) 2004 Jari Häkkinen
[1275]92Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
[1262]93
94This file is part of yat library, http://trac.thep.lu.se/yat
95
96The yat library is free software; you can redistribute it and/or
97modify it under the terms of the GNU General Public License as
98published by the Free Software Foundation; either version 2 of the
99License, or (at your option) any later version.
100
101The yat library is distributed in the hope that it will be useful, but
102WITHOUT ANY WARRANTY; without even the implied warranty of
103MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
104General Public License for more details.
105
106You should have received a copy of the GNU General Public License
107along with this program; if not, write to the Free Software
108Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
109USA.
110}}}
Note: See TracBrowser for help on using the repository browser.