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