The Good News and the Bad News

The ADCP Toolbox has evolved from the work of several programmers and projects over time and actually requires several separate toolboxes to be installed on the users computer in order to run. Therefore, it is not necessarily the easiest installation process.

The Good News is that we are currently working on creating a single ZIP file that can be downloaded and installed onto the users computer in one easy step.

The Bad News is that we do not have that ready for this release of the ADCP Toolbox. Hopefully soon!

Step One: Required - Install the NetCDF Toolbox

1. The user must first download the NetCDF Toolbox onto their computer. The NetCDF Toolbox is required to run the ADCP Toolbox. Follow the downloading steps listed on the website for your particular operating system, then go to Step Two, listed below.

Step Two: Create a startup function in MATLAB

2. 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.

   Note: The first command in the startup file 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

3. The ADCP Toolbox must be downloaded in binary format. Check the File Inventory List to be sure you have all the correct files. (Click here for WinZip if needed.)

4. Unzip the file into a folder, preferably named ADCPTools, in your MATLAB\ Toolbox\Work directory. Add the three new directories (ADCPTools, AddOns, and extraMs) to the path in the startup file.

5. The ADCP Toolbox requires eight separate toolboxes that are in the form of p-code installers. These p-code installers are included in the ADCP Toolbox ZIP file in a directory named \Installers. These must be installed in MATLAB individually. (This is where is where we are trying to streamline the process.)

   My personal preference is to move the p-code installers out of the \Installers directory, and into the \AddOns directory so that the new folders that are being created will be just below the \AddOns directory. The p-code installers can then be placed back into the \Installers directory to keep it all nice and neat.

   1. To install the p-code files, open MATLAB and change the directory to the folder where the p-code folders are located.
   2. At the MATLAB prompt, type the name of the p-code, for example 'epic_install'. A new folder will be created for each p-code. All the p-codes may be installed at one time. You do not need to exit MATLAB after each installation.
      
      

   Note: When installing the first p-code, the installation may crash. Just clear the command window and try it again. The reason for this initial crash is that the installer is looking for a function that is within the installer. Once it crashes, the function is out of the installer and the installer can continue without problem. (Another item that will be streamlined in the future!)

3. At the end of each installer, a 'test' may be suggested. Make a note of the name of the test. You will need to run them at the end of the installation. It may be helpful to start diary file to log the installation and then you could go back and look for the names of each test.
4. After all files have been installed, add the file paths to the directory in the startup file, exit MATLAB, and restart MATLAB. If tests was requested, perform the tests at this time.

Note: Make sure to read any instructions in the command window during the installation of the p-codes.

Note: Be sure to create or update your MATLAB path to include these toolboxes.

Note: An inventory of all m-files in the ADCP Toolbox can be viewed here.

Step Four: Optional - Install surface.exe from RD Instruments

6. The RD Instruments SURFACE.EXE program is also utilized in the ADCP Toolbox. This program can be obtained from the RD Instruments website.