source: trunk/README @ 1939

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

fixes #529

  • 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.8 KB
RevLine 
[2]1$Id: README 1939 2009-05-01 16:58:23Z peter $
2
[1939]3= About yat =
[573]4
[1939]5This directory contains the yat library. For an overview of the
6project, visit
7 
8    http://dev.thep.lu.se/yat
[573]9
[1939]10
11= Configuring and building yat =
12
[1262]13 1. If you checked out this project from the subversion repository you
14    must run '`bootstrap`' to initialize the build system.
15 2. Issue '`./configure`' to create the Makefiles. Optionally run
16    configure with '`--enable-debug`', which will turn on debug
17    options.
18 3. Compile with '`make`'.
[1303]19 4. Optionally do '`make check`' to run test programs.
20 5. '`make doc`' will generate documentation.
21 6. Issue '`make install`' to install the package on your system,
22    documentation will not be installed if documentation was not
[1939]23    generated above. Default installation location is `/usr/local`;
[1303]24    this can be changed with
25    '`./configure --prefix=/dir/to/install/to`'.
[573]26
[1939]27The `configure` script has additional options; `./configure --help`
28will offer you those choices or refer to Requirements below.
[848]29
[1059]30= Requirements =
31
[1262]32Except for the obviously needed C++ compiler there are a few packages
33and programs required for compiling yat and generate supporting
34material. The configure script will look for required programs and
35report failure to meet the requirements. Here we list some of the
[1557]36requirements, but omit required standard utilities such as echo and
[1262]37sed since these are normally available.
[1059]38
[1262]39== Required packages ==
[1059]40
[1262]41=== GSL ===
[1059]42
[1262]43GNU Scientific Library, [http://www.gnu.org/software/gsl/ GSL] version
[1939]441.8 or later. If you have GSL installed in a non-standard location,
45`./configure --with-gsl-prefix=DIR` can be useful to provide the
46location of GSL. The `gsl-config` script, which is used to retrive
47needed compiler and linker flags, is expected to be found in
48`DIR/bin/`.
[1059]49
[1262]50=== BLAS ===
[1059]51
[1262]52A C implementation of Basic Linear Algebra Subprograms
53([http://www.netlib.org/blas BLAS]) is required. GSL comes with a
54reference implementation, but you should consider getting a hardware
55optimized implementation. ATLAS provides optimized BLAS (see below).
[1059]56
[1939]57The `configure` script searches for many different BLAS libraries in a
58specific order (for details refer to `m4/acx_blas.m4`). If you want to
59use a specific BLAS library, `./configure --with-blas=LIB` may be
60useful.
61
[1325]62=== Boost ===
63
[1939]64[http://www.boost.org Boost] version 1.33 or later. If you have Boost
65installed in a non-standard location, `./configure --with-boost=DIR`
66can be useful to provide the location of Boost. Boost header files are
67expected to be found `DIR/include`.
[1325]68
[1262]69=== quiet nan ===
[1059]70
[1262]71Quiet NaN's must be supported.
[1059]72
[1353]73=== infinity ===
74
75infinity for type double must be supported.
76
[1262]77== Optional packages ==
[1059]78
[1262]79=== ATLAS ===
80
[1059]81GSL supplies a reference implementation of BLAS. You may want to
[1262]82consider using hardware optimized BLAS. The
83[http://math-atlas.sourceforge.net/ ATLAS] software provides an
84automatic hardware optimized BLAS library.
[1059]85
86The detection of ATLAS is supported by the yat configuration script
87but in many cases the ATLAS libraries are installed in
[1262]88non-conventional directory locations. As an example, on Fedora 8,
89ATLAS libraries are
[1059]90located in /usr/lib/atlas or /usr/lib64/atlas depending on your
91hardware architecture. If you have ATLAS installed and the configure
92script fails to locate it, try to add the location to the atlas
[1078]93libraries when running configure:
[1059]94
[1424]95  #> ./configure LDFLAGS="-L/usr/lib64/atlas"
[1059]96
[1262]97=== Doxygen ===
[1059]98
[1442]99[http://www.doxygen.org/ Doxygen] 1.5 (or newer) is required for
100generation of the API documentation. Doxygen uses a number of
101applications, epstopdf, latex, makeindex, and pdflatex. If any of
102these applications are missing, generation of API documentation is
103disabled.
[1262]104
[1272]105= Documentation =
[1262]106
[1272]107The API documentation for the latest release is availabe in PDF and
[1437]108HTML and can be found through http://dev.thep.lu.se/yat. If you wish
[1272]109to build a local copy, issue `make doc` and you will find the
110documents in directory `doc/`.
[1262]111
[1368]112= Developers =
113
[1371]114See file README.developer for developer specific information.
[1368]115
[1262]116----------------------------------------------------------------------
117{{{
118Copyright (C) 2003 Jari Häkkinen, Peter Johansson
119Copyright (C) 2004 Jari Häkkinen
[1275]120Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
[1262]121
[1437]122This file is part of yat library, http://dev.thep.lu.se/yat
[1262]123
124The yat library is free software; you can redistribute it and/or
125modify it under the terms of the GNU General Public License as
[1486]126published by the Free Software Foundation; either version 3 of the
[1262]127License, or (at your option) any later version.
128
129The yat library is distributed in the hope that it will be useful, but
130WITHOUT ANY WARRANTY; without even the implied warranty of
131MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
132General Public License for more details.
133
134You should have received a copy of the GNU General Public License
[1487]135along with yat. If not, see <http://www.gnu.org/licenses/>.
[1262]136}}}
Note: See TracBrowser for help on using the repository browser.