=======================================================================
                      README PLASMA Installer
=======================================================================

Version: 0.9
Release date: July 4th 2009
University Of Tennessee

==========================================================================
INTRODUCTION


The PLASMA installer is a set of python scripts developed to ease
the installation of the PLASMA library. It can automatically
download, configure and compile the PLASMA including it BLAS
dependency. All it needs is the  C and FORTRAN compilers.
Please note that this is an alpha version and, even if
it has been tested on a wide set of systems, may not work. In case you
encounter a problem, your feedback would be greatly appreciated and
would be very useful to improve the quality of this installer.
Please submit your complaints and suggestions to the PLASMA forum:
              http://icl.cs.utk.edu/plasma/forum/


==========================================================================
INSTALL

Here's a list of the flags that can be used to provide the installer
information about the system like, for example, the C and Fortran compilers, the
BLAS library that is already present on the system and need not be downloaded.


          -h or --help        : prints this message

          --prefix            : path where to create the libraries, build and log of the installer

          --cc=[CMD]          : the C compiler.

          --fc=[CMD]          : the Fortran compiler.

          --ccflags=[FLAGS]   : the flags for the C compiler
                                 (default -O3)

          --fcflags=[FLAGS]   : the flags for the compiler
                                 (default -O3)

          --ldflags_c=[flags] : loader flags when main program is in C. Some compilers (e.g. PGI) require 
                                 different options when linking C main programs to Fortran subroutines
                                 and vice-versa

          --ldflags_fc=[flags]: loader flags when main program is in Fortran. Some compilers (e.g. PGI) require 
                                 different options when linking Fortran main programs to C subroutines
                                 and vice-versa

          --makecmd=[CMD]     : the make command
                                 (make by default)

          --blaslib=[LIB]     : a BLAS library
                                 (path should be absolute if --prefix is used)

          --downblas          : if you do not want to provide a BLAS
                                 we can download and install it for you

          --nbcores           : The number of cores to be used by the testing.
                                 (2 by default)

          --notesting         : disables the PLASMA testing. The BLAS library is not
                                required in this case.

          --clean             : cleans up the installer directory.


If the required packages cannot be automatically downloaded (for
example, because no network connection is available on the system),
you can take them any way you like from the following URLs and place
them in the build directory (if the directory does not exist, create
it):

BLAS      : http://netlib.org/blas/blas.tgz
PLASMA    : http://icl.cs.utk.edu/projectsfiles/plasma/pubs/plasma.tar.gz

Please note that, in the case where the installer is asked to
automatically download and install the BLAS library, the reference
BLAS is installed and, thus, very low performance is to be expected.
It is strongly recommended that you use an highly optimized BLAS
library (like ATLAS, MKL, GotoBLAS, ESSL etc.) and provide a path to
its location through the --blaslib flag.

==========================================================================
AUTHORS

The author of the PLASMA installer is:
Julie Langou      (Electrical Engineering and Computer Science Department, University of Tennessee Knoxville)

The PLASMA installer is based on the previous released ScaLAPACK installer written by :
Alfredo Buttari   (Institut de Recherche en Informatique de Toulouse, Centre National de la Recherche Scientifique, Toulouse, France)
Julie Langou      (Electrical Engineering and Computer Science Department, University of Tennessee Knoxville)
Julien Langou     (Department of Mathematical Sciences, University of Colorado Denver)

