README

   1 1. INTRODUCTION
   2 ===============
   3
   4 1.1 GENERAL DESCRIPTION
   5 =======================
   6
   7 LIBGPIV is a software library for the so-called Digital Particle Image
   8 Velocimetry (DPIV). It consists the core functions for image
   9 recording, image processing, image interrogation (resulting into
  10 estimators of particle image displacements, i.e. PIV data), validation
  11 of PIV data (on peak-locking effects, erroneous vectors (outliers),
  12 checking on velocity gradient), post-processing (functions for
  13 calculating (scalar) derivatives of the PIV data, like vorticity and
  14 strain), input/output functions, memory allocation etc.
  15
  16 The library has been implemented in several command-line driven
  17 programs that can be found in the GPIVTOOLS distribution. A Graphic
  18 User Interface (GPIV) is available that controls all processes
  19 and parameters and displays its results graphically in a more
  20 advanced way. GPIV has been implemented with the GTK/GNOME libraries
  21 and resides in GPIV distribution. PyGpiv is a Python module wrapped
  22 from this library for writing your own scripts.
  23
  24 The library has been written in ANSI-C and have been developed on a
  25 GNU/LINUX box and should work on any UNIX-like system.
  26 The main web page can be found at:  http://gpiv.sourceforge.net/
  27
  28
  29 2 LICENSE
  30 ===========
  31
  32 LIBGPIV is Free Software licensed under the GNU
  33 Public license terms. See the COPYING file for the license.
  34
  35
  36 3 COMPILATION AND INSTALLATION
  37 ================================
  38
  39 See INSTALL for a more extended description.
  40
  41 The following libraries are needed to build this library:
  42 - fftw and (rfftw) library for Fast Fourier Transformation
  43   (http://www.fftw.org)
  44 - Perl, version 5.005_03 or newer
  45 - hdf5 library
  46 - gslcblas library
  47 - gsl library
  48 - Gnuplot
  49
  50 Unpacking and compilation:
  51 gzip -d gpiv-0.2.tar.gz
  52 tar -xvf gpiv-0.2.tar
  53 ./configure
  54 make: to build the library and tools
  55 make install
  56 make uninstall: removes installed files and directries that have been
  57 created.
  58
  59 There are also pre-compiled (.deb) packages available that eases the
  60 installation.
  61
  62 Libgpiv uses g_get_tmp_dir () from the Glib library to obtain the tmp
  63 directory. Therefore, set TMPDIR, TMP or TEMP to your local temporary
  64 directory. For bash shell: export TMPDIR="/home/my_user_derectory/tmp".
  65 Else, the system-wide /tmp directory will be used.
  66
  67 The configuration for the parameters is found in /etc/gpiv.conf. If
  68 absent, hard-coded default values will be used.
  69
  70
  71 4. FINAL REMARKS
  72 =================
  73
  74 I hope that the programs will work fine (cross your fingers) and that
  75 you'll enjoy it. Remarks, suggestions **and patches** for
  76 improvements/additions are welcome.
  77
  78 Gerber van der Graaf
  79
  80