README

   1
   2     +--------------------------------------------------------------------+
   3     |                              Clay                                  |
   4     +--------------------------------------------------------------------+
   5
   6  +--------------------------------------------------------------------------+
   7  |  / __)(  )    /__\ ( \/ )                                                |
   8  | ( (__  )(__  /(__)\ \  /         Chunky Loop Alteration wizardrY         |
   9  |  \___)(____)(__)(__)(__)                                                 |
  10  +--------------------------------------------------------------------------+
  11  | Copyright (C) 2012 University of Paris-Sud                               |
  12  |                                                                          |
  13  | This library is free software; you can redistribute it and/or modify it  |
  14  | under the terms of the GNU Lesser General Public License as published by |
  15  | the Free Software Foundation; either version 2.1 of the License, or      |
  16  | (at your option) any later version.                                      |
  17  |                                                                          |
  18  | This library is distributed in the hope that it will be useful but       |
  19  | WITHOUT ANY WARRANTY; without even the implied warranty of               |
  20  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser  |
  21  | General Public License for more details.                                 |
  22  |                                                                          |
  23  | You should have received a copy of the GNU Lesser General Public License |
  24  | along with this software; if not, write to the Free Software Foundation, |
  25  | Inc., 51 Franklin Street, Fifth Floor,                                   |
  26  | Boston, MA  02110-1301  USA                                              |
  27  |                                                                          |
  28  | Clay, the Chunky Loop Alteration wizardrY                                |
  29  | Written by Joel Poudroux, joel.poudroux@u-psud.fr                        |
  30  +--------------------------------------------------------------------------+
  31
  32
  33 INSTALL
  34 ------------------------------
  35
  36 By default Clay is linked with Clan, Candl and Cloog. This is useful to run
  37 Clay with the -c (compile) option.
  38
  39 If Clan, Cloog (need Osl), Candl, OSL..., are not present on your system
  40 use the bundled option in the redo.sh and run the get_submodules.sh
  41
  42 Edit the redo.sh to modify the configuration.
  43
  44
  45   - linked with Clan and ClooG
  46     -c : input  : .c file
  47          output : .c file
  48
  49   - linked with Clan
  50     --readc : input : .c file
  51
  52   - linked with ClooG
  53     --printc : output : .c file
  54
  55   - linked with Candl
  56     Warning: Candl need to be compiled with Piplib in GMP, because Cloog is
  57     only compatible with GMP (change the variable BITS in the configure of
  58     Candl).
  59     If there is a violation, the violation graph is printed otherwise it's the
  60     result (scop or .c file).
  61     You can use the --nocandl to not check dependencies.
  62
  63
  64 Installation:
  65 $ ./redo.sh
  66 $ make install
  67
  68 Alternative installation with CMake:
  69 $ mkdir build
  70 $ cd build
  71 $ cmake .. # -DCMAKE_INSTALL_PREFIX="/your/install/directory"
  72 $ make
  73 $ make test
  74 $ # make install # sudo make install # su -c "make install"
  75 $ make doc
  76 $ make doxygen
  77
  78
  79 SUPPORT
  80 ------------------------------
  81
  82 For bug reporting or any suggestions, please send an email to the author
  83 Joel Poudroux <joel.poudroux@u-psud.fr>
  84 or to
  85 Cedric Bastoul <cedric.bastoul@inria.fr>
  86