README.Install
changeset 34 e5731cc26b5b
parent 33 dd5b67a41791
child 35 3d769eee8c4f
equal deleted inserted replaced
33:dd5b67a41791 34:e5731cc26b5b
     1 ======================================================================
       
     2                     R E A D M E . I N S T A L L 
       
     3                     doc: Tue May 15 18:42:56 2012
       
     4                     dlm: Fri Jun 15 07:36:52 2012
       
     5                     (c) 2012 A.M. Thurnherr
       
     6                     uE-Info: 46 67 NIL 0 0 72 3 2 4 NIL ofnI
       
     7 ======================================================================
       
     8 
       
     9 =Processing Software=
       
    10 
       
    11 The re-implemented shear method is written entirely in perl and requires
       
    12 the following sub-modules to be installed:
       
    13 
       
    14 ADCP_tools	a set of tool and libraries to deal with RDI BB ADCP data;
       
    15 			available via link from http://www.ldeo.columbia.edu/LADCP
       
    16 
       
    17 ANTSlib		a library for dealing with the ANTS ASCII file format;
       
    18 			available via link from http://www.ldeo.columbia.edu/LADCP
       
    19 
       
    20 LADCPproc	this software; available via link from
       
    21 			http://www.ldeo.columbia.edu/LADCP
       
    22 
       
    23 The code runs with version 5.12.4 of perl or later but it may well work
       
    24 with older versions, too. It is recommended that these three modules are
       
    25 installed in three separate directories. 
       
    26 
       
    27 In addition to the core modules listed above, the software also
       
    28 requires Eric Firing's geomag code (written in c) that is available
       
    29 from http://currents.soest.hawaii.edu/hg.
       
    30 
       
    31 The only step required to set up the software is to add the directories
       
    32 of the ADCP_tools, ANTSlib, LADCPproc, and geomag to the search path ---
       
    33 refer to the manual of your shell on how to accomplish this.
       
    34 
       
    35 To test correct setup of the software, simply call [LADCPproc] in the
       
    36 directory where you intend to process the LADCP data. If the software
       
    37 has been correctly installed, the usage of [LADCPproc] will be
       
    38 produced. 
       
    39 
       
    40 
       
    41 =Matlab Interface=
       
    42 
       
    43 As described in [README.Output], all output produced by this software is
       
    44 in a proprietary ASCII format called ANTS. In order to import/export
       
    45 ANTS files into/from Matlab the module Matlab_tools is required. This,
       
    46 too, is available via link from http://www.ldeo.columbia.edu/LADCP.
       
    47