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

VERSION 0.1  :  April     2012 (beta)
VERSION 0.2  :  May       2012
VERSION 0.3  :  November  2012

* To INSTALL and use micMAGMA, first set MKL and compiler variables by
  sourcing for example
  > source /mnt/scratch/sw/intel/composer_xe_2013.0.079/bin/compilervars.sh intel64
  > source /mnt/scratch/sw/intel/composer_xe_2013.0.079/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. 
  Example is given in make.inc.mkl. 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 'interface_mic/server' and copy
  magma_mic_server to the mic, e.g.,
  scp -i ~/.ssh/id_rsa ./interface_mic/server/magma_mic_server root@mic0:/tmp/
  Login on the mic (e.g., ssh -i ~/.ssh/id_rsa root@mic0) and run the server
  env USE_2MB_BUFFERS=3000 OMP_NUM_THREADS=240 KMP_AFFINITY=proclist=[1-240],granularity=fine,explicit /tmp/magma_mic_server
   
  In another shell run a test program. Provided are a number of
  drivers testing different routines (in 'testing'). 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_mic.cpp'.


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.

