= UVMAT =
UVMAT is a set of Matlab functions and graphic user interfaces for Particle Imaging Velocimetry with tools for scanning images and data files (vectors and scalars in 2D and 3D), geometric calibrations, image pre-processing and analysis of time series. It is designed to favor data management, relying on the standard NetCDF file format and xml documentation files.

This free Matlab toolbox (GNU licence) contains a PIV program under Matlab and a graphic user interface to run other programs, like the Correlation Image Velocimetry software CivX. Tools are provided to run programs on a computer cluster with different file administration systems (sge or oar).

This free Matlab toolbox contains a graphic user interface to scan and visualize series of images and data fields (vectors and scalars). It provides statistics and various processing for these data. It also contains a graphic user interface to run the Correlation Image Velocimetry software CIVx and analyze its results.

== Prerequisit ==
This toolbox requires Matlab, release R 2009 or more recent. It can be run with any computer system on which Matlab is installed (in particular Linux, MacOS and Windows). No additional toolbox from Matlab is requested. The Matlab compiler is however useful for the option of dispatching computations on a computer cluster.

== Installation ==
The package contains specific functions updated on the SVN server, as well as a 'fixed' archive. It contains the toolboxes 
 * xmltree (http://www.artefact.tk/software/matlab/xml/xmltree) , used for reading and editing xml files
 * geometric calibration (http://www.vision.caltech.edu/bouguetj/calib_doc/)
These toolboxes are provided for convenience in the archive but an upgrade from their source web site may be needed depending on the system and Matlab version.

The archive also contains binary files compiled from Fortran programs CivX. This is not mandatory as it is now replaced by Matlab functions within uvmat. These binaries depend on the operating system, unlike the Matlab toolboxes, so that archives are provided for different systems. 
 
=== Windows installation ===
Extract the following archive [http://coriolis.legi.grenoble-inp.fr/IMG/tgz/uvmat_include_win32.tgz windows 32 bits].

Then perform a checkout in this directory using [http://tortoisesvn.tigris.org/ Tortoise SVN]. The repository is available for download at http://servforge.legi.grenoble-inp.fr/svn/soft-uvmat/trunk/src/.

=== Linux automated installation ===
The procedure under linux requires the svn and wget commands from a shell.  See LinuxInstallation.

=== MacOS automated installation ===
The procedure under !MacOs requires the svn and curl commands from a shell.  See MacOsInstallation.

=== LEGI Cluster Installation ===
If you wish to install UVMAT in your home of the LEGI cluster, please see LegiClusterInstallation.

=== CivX developper installation (Fortran programs for advanced users) ===
If you also wish to have the last version of CIV and compile it on your machine, please see CivxDevelloperInstallation

== Help and documentation ==
Online help is available at :

  UvmatHelp (in progress)

see also the earlier version: [http://coriolis.legi.grenoble-inp.fr/spip.php?article72]

help is also integrated in the UVMAT package as a .html help file (uvmat_doc.html), but the on-line version is better updated.

== Tutorial ==
 * [wiki:TutorialEx Tutorial: image display]

 * [wiki:"Tutorial: projection objects" Tutorial: projection objects]

 * [wiki:"Tutorial: geometric calibration"]

 * [wiki:"Tutorial: processing image series"]

 * [wiki:"Tutorial: Particle Image Velocimetry"]

 * [wiki:"Tutorial: displacement measured by image correlation"]