Skip Navigation
USGS - science for a changing world

Woods Hole Science Center

Skip Navigation

ADCP Tools Version 4.0 - Setup and Installation

Creators: Jessica M. Cote, Frances S. Hotchkiss, Marinna Martini, Charles R. Denham
Maintained and updated by: Andrée L. Ramsey

ADCP Tools Version 4.0 containing RDI2CDF Version 2.2c posted 1/24/00.

(This page was updated on Tuesday, 16-Oct-2007 09:37:05 EDT)

Please Note:

This is not the easiest of installation procedures... our apologies. It comes from the fact that this toolbox has evolved from the work of several programmers and projects over time. You will actually be installing several separate toolboxes which work together to make the ADCP Toolbox as a whole. Any suggestions are welcomed and appreciated.

 

Step One: Required - Install the NetCDF Toolbox

  1. Before the ADCP Toolbox is installed on any system, the user must first download the NetCDF Toolbox. Follow the downloading steps listed on the website for your particular operating system.

Step Two: Create a startup function in MATLAB

  1. At this point it is a good idea to create a startup function in MATLAB, which can be added to as the files of the ADCP Toolbox are installed. Here is an example startup file.

  2. Note: The first command in the startup function should be ncstartup. Be sure to save the startup function in the \MATLAB\bin directory and add this directory to your MATLAB path.

Step Three: Install the ADCP Toolbox

  1. The ADCP Toolbox must be downloaded in binary format. All file names and extensions must be listed exactly as they are on the website. A list of all the functions and folders included in the ADCP Toolbox may be viewed here.

  2. Place the downloaded files in a folder (preferably named ADCPtools) in the toolbox or work area of MATLAB. Add this directory to the path in the startup file. There are 21 files in the main ADCP Toolbox. Additional files are included in the toolbox and are described in the following steps.

  3. The ADCP Toolbox requires additional functions written by Chuck Denham and Rich Signell. These functions are included in the ADCP Toolbox Zip file. The Zip file automatically places these functions in a folder names \AddOns. It is recommended that this folder be placed in the toolbox or work area of MATLAB. Be sure to add the \AddOns directory to the path in the startup file.

  4. Additional useful functions are also included in the ADCP Toolbox. The Zip file automatically places these functions in a folder name \ExtraMs. It is recommended that this folder be placed in the toolbox or work area of MATLAB. Be sure to add the \ExtraMs directory to the path in the startup file.

Step Four: Install the p-codes

  1. The ADCP Toolbox requires 8 p-code installers. These installers are included in the ADCP Toolbox Zip file, in the \AddOns directory. Create a new folder within the ADCP Toolbox area of MATLAB and move each of the p-code files into that folder.

  2. Open MATLAB and use the cd command to change to the directory where the p-code installers are located.

  3. At the MATLAB prompt, type the name for the p-code that you wish to install, i.e. type 'epic_install' for 'epic_install.p'. The p-code will un-bundle and create a new folder within the MATLAB directory that you are working. The new folder will be filled with all the functions associated with that p-code.

  4. After each p-code is un-bundled, read the command window for any instructions or tests that may be requested. Add the folder's path to the startup file, exit MATLAB and restart MATLAB. If a test was requested, perform the test at this time. Be sure to change back to the directory where the p-codes are located before trying to install the next p-code.

Step Five: Optional - Install SURFACE.EXE from RD Instruments

  1. The RD Instruments SURFACE.EXE program is also utilized in the ADCP Toolbox. This program can be obtained from the RD Instruments website. The ADCP Toolbox will function without the SURFACE.EXE program.
Skip Navigation

Accessibility FOIA Privacy Policies and Notices

Take Pride in America logo USAGov logo U.S. Department of the Interior | U.S. Geological Survey

URL: woodshole.er.usgs.gov/operations/stg/pubs/ADCPtools/adcptool40/readme40.html
Page Contact Information: WHSC Webmaster
Page Last Modified: Tuesday, 16-Oct-2007 09:37:05 EDT