Changeset 1262


Ignore:
Timestamp:
Apr 9, 2008, 12:00:36 AM (13 years ago)
Author:
Jari Häkkinen
Message:

Addresses #208. Updated list of requirements and restructured the README file.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README

    r1214 r1262  
    11$Id$
    22
     3
     4= Compiling =
     5
     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`'.
     17
     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.
     21
     22
     23= Requirements =
     24
     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.
     31
     32== Required packages ==
     33
     34=== GSL ===
     35
     36GNU Scientific Library, [http://www.gnu.org/software/gsl/ GSL] version
     371.6 or later.
     38
     39=== BLAS ===
     40
     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).
     45
     46=== quiet nan ===
     47
     48Quiet NaN's must be supported.
     49
     50== Optional packages ==
     51
     52=== ATLAS ===
     53
     54GSL supplies a reference implementation of BLAS. You may want to
     55consider using hardware optimized BLAS. The
     56[http://math-atlas.sourceforge.net/ ATLAS] software provides an
     57automatic hardware optimized BLAS library.
     58
     59The detection of ATLAS is supported by the yat configuration script
     60but in many cases the ATLAS libraries are installed in
     61non-conventional directory locations. As an example, on Fedora 8,
     62ATLAS libraries are
     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
     66libraries when running configure:
     67
     68  #> LDFLAGS="-L/usr/lib64/atlas" ./configure
     69
     70=== Doxygen ===
     71
     72[http://www.doxygen.org/ Doxygen] is required for regeneration of the
     73API documentation
     74
     75
     76
     77----------------------------------------------------------------------
     78{{{
    379Copyright (C) 2003 Jari Häkkinen, Peter Johansson
    480Copyright (C) 2004 Jari Häkkinen
     
    2399Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
    24100USA.
    25 
    26 
    27 If you checked out this project from the subversion repository you
    28 must run './bootstrap' to initialize the build system. Now do
    29 './configure' to create the Makefiles. Optionally you can run
    30 configure with '--enable-debug', which will turn on debug options.
    31 
    32 Issue 'make' to compile the project.
    33 
    34 Optionally you can do 'make check' to run test programs. 'make doc'
    35 will generate documentation.
    36 
    37 'make install' will install the package into your system. Default
    38 installation location is /usr/local, this can be changed with
    39 ./configure --prefix=/dir/to/install/to.
    40 
    41 If you keep your working copy up to date with the repository you must
    42 issue 'autoreconf' in the yat root directory when 'configure.ac' is
    43 updated.
    44 
    45 Contact information through http://trac.thep.lu.se/yat
    46 
    47 
    48 = Requirements =
    49 
    50 == quiet nan ==
    51 
    52 Quiet NaN's must be supported.
    53 
    54 == BLAS ==
    55 
    56 A C implementation of Basic Linear Algebra Subprograms (cBLAS) is
    57 required. GSL comes with a reference implementation, but you should
    58 consider getting a hardware optimized implementation. ATLAS provides
    59 optimized BLAS (see below).
    60 
    61 == GSL ==
    62 
    63 GNU Scientific Library, GSL http://www.gnu.org/software/gsl/.
    64 
    65 
    66 = Optional packages =
    67 
    68 == ATLAS ==
    69 
    70 GSL supplies a reference implementation of BLAS. You may want to
    71 consider using hardware optimized BLAS. The ATLAS
    72 (http://math-atlas.sourceforge.net/) software provides an automatic
    73 hardware optimized BLAS library.
    74 
    75 The detection of ATLAS is supported by the yat configuration script
    76 but in many cases the ATLAS libraries are installed in
    77 non-conventional directory locations. On Fedora 8, ATLAS libraries are
    78 located in /usr/lib/atlas or /usr/lib64/atlas depending on your
    79 hardware architecture. If you have ATLAS installed and the configure
    80 script fails to locate it, try to add the location to the atlas
    81 libraries when running configure:
    82 
    83   #> LDFLAGS="-L/usr/lib64/atlas" ./configure
    84 
    85 === doxygen ===
    86 
     101}}}
Note: See TracChangeset for help on using the changeset viewer.