===================
micMAGMA README FILE
===================

VERSION 0.1  :  April     2012 (beta)
VERSION 0.2  :  May       2012
VERSION 1.0  :  March     2013

* To INSTALL and use micMAGMA, first set MKL and compiler variables by
  sourcing for example
  > source /mnt/scratch/sw/intel/composerxe_mic.0.022/bin/compilervars.sh intel64
  > source /mnt/scratch/sw/intel/composerxe_mic.0.022/mkl/bin/mklvars.sh intel64
  Second, modify the make.inc file to indicate where 
  MIC BLAS, CPU BLAS, and LAPACK are installed on your system. 
  Examples are given in make.inc.mkl, make.inc.acml, make.inc.goto, 
  and make.inc.atlas, showing how to link correspondingly to MKL, ACML,
  GOTO BLAS or ATLAS BLAS. After proper modification of the make.inc
  file, typing 'make', will create 
   1) the libmicmagma.a and libmicmagmablas.a libraries in directory 'lib'
   2) testing drivers in directory 'testing'.

* To TEST micMAGMA, go to directory 'testing'. Provided are a number of
  drivers testing different routines. These drivers are also useful
  as examples on how to use micMAGMA, as well as to benchmark the performance.
 
* To TUNE micMAGMA, you can modify the blocking factors for the algorithms of
  interest in file 'src/get_nb.cpp'. The default values are tuned for 
  AMD Radeon 7970 (Tahiti) GPUs. You can also compare your performance to 
  what we get, given in file 
  'testing/results_micmagma.txt', as an easy check for your installation.


For more INFORMATION, please refer to the MAGMA homepage and user forum:
  
  http://icl.cs.utk.edu/magma/
  http://icl.cs.utk.edu/magma/forum/

The MAGMA project supports the package in the sense that reports of 
errors or poor performance will gain immediate attention from the 
developers. Such reports, descriptions of interesting applications, 
and other comments should be posted on the MAGMA user forum.

