source: trunk/doc/README_INSTALL.txt @ 51

Last change on this file since 51 was 51, checked in by gostiaux, 11 years ago

added doc repository at the same level than src

File size: 4.0 KB
Line 
1--------------------------------------------------
2Steps for installing uvmat:
3--------------------------------------------------
4- Install Matlab, release R 13 or more recent.
5 
6- Copy the whole UVMAT directory at a convenient location. Be careful on Windows machines:
7 names of files and directories used must not contain blanks.
8- Add the full path of this UVMAT directory, as well as the ones of the mexnc, netcdf_toolbox and bin (or bin/win32) folder,
9to the current matlab function paths (using 'File/SetPath...' in the matlab menu bar), so that
10function names are recognized from the Matlab prompt.
11-For reading avi movies, a codec must be available on the computer. This is the case for instance if a
12fire wire port has been installed. See the documentation of Matlab for more details.
13
14--------------------------------------------------
15Netcdf library needed for old versions of Matlab (if the builtin function netcdf.create does not exist):
16--------------------------------------------------
17- Install the (free) toolbox for reading and writing netcf files for the velocity fields: download from http://sourceforge.net/projects/mexcdf/. You must download both mexnc and netcdf_toolbox packages and
18 copy them under the folder 'toolbox' in your Matlab directory.
19- download netcdf.dll (also provided in this directory, but you may already have in bin/win32 in your Matlab directory)
20(http://www.unidata.ucar.edu/software/netcdf/docs/netcdf-install/Getting-Prebuilt-DLL.html#Getting-Prebuilt-DLL)
21- To check whether this installation is successful, type 'ncbrowser' on the Matlab prompt:
22 you should get a browser allowing to scan netcdf files.
23
24--------------------------------------------------
25Installing the civx software with the matlab interface (local version):
26--------------------------------------------------
27- Install uvmat as above.
28- Copy at a convenient location the executable binary civ (still under tests) and netcdf.dll (vrsion 3.4).
29-Document the path to these binaries by editing the corresponding xml text files 'PARAM_WIN.xml' (for windows systems) and/or 'PARAM_LINUX.xml' (for Linux), which must stay in the UVMAT directory.
30-Alternatively, use the older versions involving 4 separate binaries:
31civ1.exe: simple correlation imaging velocimetry
32civ2.exe: hierarchical algorithm for correlation imaging velocimetry
33fix_flag.exe: program for removing false vectors (only needed for batch option)
34patch.exe: program for thin shell spline interpolation
35
36--------------------------------------------------
37Note for compiling the civx software on Linux system:
38-------------------------------------------------
39The binaries are compiled with Intel Fortran v7 and gcc3.3; the following libraries need to be present on your sstem :
40libpng: http://www.libpng.org/pub/png
41intel fortran libraries, please download it here : http://www.civproject.org/files/civx/libIntel.tgz
42extract them, and add the folder to you /etc/ld.so.conf file.
43
44--------------------------------------------------
45Installation of advanced geometric callibration (Tsai method)
46-------------------------------------------------
47- Copy at a convenient location the executable binary ccal_fo.
48- Document the path under the key <GeometryCalib_exe> in the file 'PARAM_WIN.xml' or 'PARAM_LINUX.xml'
49
50--------------------------------------------------
51Installation of xml schemas
52-------------------------------------------------
53- Copy the schemas at a convenient location
54- Document the path under the key <SchemaPath in the file 'PARAM_WIN.xml' or 'PARAM_LINUX.xml'
55
56-------------------------------------------------
57Changes: uvmat2.1 -> 2.2:
58-------------------------------------------------
59- reading avi movies using mmreader (for version 2009 of matalb)
60- rationalisation of netcdf reading and writing functions, using functions UVMAT/nc2struct and UVMAT/struct2nc. Use of builtin netcdf Matlab function when available (version 2009)
61- replacement of all functions using image processing toolbox.
62- improvement of vector color representation
63- improvement of the get_field interface to scan and plot fields from general netcdf files
Note: See TracBrowser for help on using the repository browser.