source: trunk/README @ 1281

Last change on this file since 1281 was 1275, checked in by Jari Häkkinen, 14 years ago

Updating copyright statements.

  • 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.6 KB
RevLine 
[2]1$Id: README 1275 2008-04-11 06:10:12Z 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`'.
12 1. Optionally do '`make check`' to run test programs.
13 1. '`make doc`' will generate documentation.
14 1. Issue '`make install`' to install the package on your
15    system. Default installation location is `/usr/local`, this can be
16    changed with '`./configure --prefix=/dir/to/install/to`'.
[573]17
[953]18If you keep your working copy up to date with the repository you must
19issue 'autoreconf' in the yat root directory when 'configure.ac' is
20updated.
[848]21
[1059]22
23= Requirements =
24
[1262]25Except for the obviously needed C++ compiler there are a few packages
26and programs required for compiling yat and generate supporting
27material. The configure script will look for required programs and
28report failure to meet the requirements. Here we list some of the
29requirements, but omit required standard utilities such as libtool and
30sed since these are normally available.
[1059]31
[1262]32== Required packages ==
[1059]33
[1262]34=== GSL ===
[1059]35
[1262]36GNU Scientific Library, [http://www.gnu.org/software/gsl/ GSL] version
371.6 or later.
[1059]38
[1262]39=== BLAS ===
[1059]40
[1262]41A C implementation of Basic Linear Algebra Subprograms
42([http://www.netlib.org/blas BLAS]) is required. GSL comes with a
43reference implementation, but you should consider getting a hardware
44optimized implementation. ATLAS provides optimized BLAS (see below).
[1059]45
[1262]46=== quiet nan ===
[1059]47
[1262]48Quiet NaN's must be supported.
[1059]49
[1262]50== Optional packages ==
[1059]51
[1262]52=== ATLAS ===
53
[1059]54GSL supplies a reference implementation of BLAS. You may want to
[1262]55consider using hardware optimized BLAS. The
56[http://math-atlas.sourceforge.net/ ATLAS] software provides an
57automatic hardware optimized BLAS library.
[1059]58
59The detection of ATLAS is supported by the yat configuration script
60but in many cases the ATLAS libraries are installed in
[1262]61non-conventional directory locations. As an example, on Fedora 8,
62ATLAS libraries are
[1059]63located in /usr/lib/atlas or /usr/lib64/atlas depending on your
64hardware architecture. If you have ATLAS installed and the configure
65script fails to locate it, try to add the location to the atlas
[1078]66libraries when running configure:
[1059]67
[1180]68  #> LDFLAGS="-L/usr/lib64/atlas" ./configure
[1059]69
[1262]70=== Doxygen ===
[1059]71
[1272]72[http://www.doxygen.org/ Doxygen] is required for generation of the
[1262]73API documentation
74
[1272]75= Documentation =
[1262]76
[1272]77The API documentation for the latest release is availabe in PDF and
78HTML and can be found through http://trac.thep.lu.se/yat. If you wish
79to build a local copy, issue `make doc` and you will find the
80documents in directory `doc/`.
[1262]81
82----------------------------------------------------------------------
83{{{
84Copyright (C) 2003 Jari Häkkinen, Peter Johansson
85Copyright (C) 2004 Jari Häkkinen
[1275]86Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
[1262]87
88This file is part of yat library, http://trac.thep.lu.se/yat
89
90The yat library is free software; you can redistribute it and/or
91modify it under the terms of the GNU General Public License as
92published by the Free Software Foundation; either version 2 of the
93License, or (at your option) any later version.
94
95The yat library is distributed in the hope that it will be useful, but
96WITHOUT ANY WARRANTY; without even the implied warranty of
97MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
98General Public License for more details.
99
100You should have received a copy of the GNU General Public License
101along with this program; if not, write to the Free Software
102Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
103USA.
104}}}
Note: See TracBrowser for help on using the repository browser.