source: trunk/README @ 1059

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

Addresses #208. Write requirements

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.9 KB
Line 
1$Id: README 1059 2008-02-08 22:50:04Z jari $
2
3Copyright (C) 2003 Jari Häkkinen, Peter Johansson
4Copyright (C) 2004 Jari Häkkinen
5Copyright (C) 2006 Jari Häkkinen, Peter Johansson
6Copyright (C) 2007 Peter Johansson
7Copyright (C) 2008 Jari Häkkinen, Peter Johansson
8
9This file is part of yat library, http://trac.thep.lu.se/yat
10
11The yat library is free software; you can redistribute it and/or
12modify it under the terms of the GNU General Public License as
13published by the Free Software Foundation; either version 2 of the
14License, or (at your option) any later version.
15
16The yat library is distributed in the hope that it will be useful, but
17WITHOUT ANY WARRANTY; without even the implied warranty of
18MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19General Public License for more details.
20
21You should have received a copy of the GNU General Public License
22along with this program; if not, write to the Free Software
23Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
24USA.
25
26
27If you checked out this project from the subversion repository you
28must run './bootstrap' to initialize the build system. Now do
29'./configure' to create the Makefiles. Optionally you can run
30configure with '--enable-debug', which will turn on debug options.
31
32Issue 'make' to compile the project.
33
34Optionally you can do 'make check' to run test programs. 'make doc'
35will generate documentation.
36
37'make install' will install the package into your system. Default
38installation location is /usr/local, this can be changed with
39./configure --prefix=/dir/to/install/to.
40
41If you keep your working copy up to date with the repository you must
42issue 'autoreconf' in the yat root directory when 'configure.ac' is
43updated.
44
45Contact information through http://trac.thep.lu.se/yat
46
47
48= Requirements =
49
50== quiet nan ==
51
52Quiet NaN's must be supported.
53
54== BLAS ==
55
56A C implementation of Basic Linear Algebra Subprograms (cBLAS) is
57required. GSL comes with a reference implementation, but you should
58consider getting a hardware optimized implementation. ATLAS provides
59optimized BLAS (see below).
60
61== GSL ==
62
63GNU Scientific Library, GSL http://www.gnu.org/software/gsl/.
64
65
66= Optional packages =
67
68== ATLAS ==
69
70GSL supplies a reference implementation of BLAS. You may want to
71consider using hardware optimized BLAS. The ATLAS
72(http://math-atlas.sourceforge.net/) software provides an automatic
73hardware optimized BLAS library.
74
75The detection of ATLAS is supported by the yat configuration script
76but in many cases the ATLAS libraries are installed in
77non-conventional directory locations. On Fedora 8, ATLAS libraries are
78located in /usr/lib/atlas or /usr/lib64/atlas depending on your
79hardware architecture. If you have ATLAS installed and the configure
80script fails to locate it, try to add the location to the atlas
81libraries when running confiure:
82
83  #> LDFLAGS="/usr/lib64/atlas" ./configure
84
85=== doxygen ===
86
87=== latex ===
88
89=== dvipdfm ===
90
91=== latex2html ===
Note: See TracBrowser for help on using the repository browser.