
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*                                                                             *
*                           FLCC LIBRARY VERSION 1.5                          *
*                                                                             *
*                                  AUTHORS                                    *
*                            Georgios Papamakarios                            *
*                               Georgios Rizos                                *
*                                                                             *
*                     Aristotle University of Thessaloniki                    *
*                          Facutly of Engineering                             *
*              Department of Electrical and Computer Engineering              *
*                                                                             *
*                               CONTACT INFO                                  *
*                          e-mail: gpapamak@auth.gr                           *
*                                  grizos@auth.gr                             *
*                                                                             *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *


-- FOLDERS IN THIS PACKAGE

      doc      documentation
      gen      generator functions in MATLAB
      inc      header files (including flcc.h)
      lib      library file (libflcc.a)
      mex      MATLAB interface files
      obj      object files
      src      source code
      test     test files
   
   
-- INSTALLATION INSTRUCTIONS

   *** PRIOR TO INSTALLING:
   
      You can edit makefile so as to set
      - the C compiler to be used
      - the CUDA compiler to be used
      - the MATLAB mex linker to be used
      - the level of optimization to be used (we recommend a high one)
      - the include path for CUDA (in case it's not the default one)
      - the library path for CUDA (in case it's not the default one)
      - the include path for MATLAB (in case it's not the default one)
      - the number of threads you would like FLCC to work with in parallel
        (a good choice should be the number of CPU cores in your system)

   *** FULL INSTALLATION:
   
      - Just issue "make install" in the main folder. After that,
        the library file (libflcc.a) will be located in folder lib.
  
      - Moreover, issue "make matlab" to build the MATLAB mex executable
        files in folder mex/bin. Then use them in your MATLAB code to
        get access to FLCC's MATLAB interface.
  
      - You can issue "make tests" to get the test programs in folder
        test/bin. You can use them to test whether FLCC has been installed
        and runs successfully.
  
      - By issuing "make all" or just "make", you will get all the above
        at the same time.
  
      - Finally, issue "make clean" to get rid of anything that has been
        produced by the above commands.
  
   *** INSTALLATION WITHOUT CUDA:
   
      You can install without CUDA (in case for example you don't have it
      in your system) by uncommenting the specified line in the makefile
      (follow the instructions in makefile's comments). After that, install
      normally as described above.
    
   *** INSTALLATION WITHOUT FFTW:
   
      You can install without FFTW (in case for example you don't have it
      in your system) by uncommenting the specified line in the makefile
      (follow the instructions in makefile's comments). After that, install
      normally as described above.
    
   *** INSTALLATION WITHOUT SINGLE OR DOUBLE PRECISION ROUTINES:
   
      By default, FLCC installs both single and double precision versions
      of its routines. You may choose to install either alone by uncommenting
      the specified line in the makefile (follow the instructions in makefile's
      comments). After that, install normally as described above.
