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