Obtaining and Installing the CTDCAL Toolbox
The CTDCAL Toolbox is intended to be used at sea, to calibrate CTD profiles as they are collected. It is platform independent and has been tested on Linux and MS Windows PCs. Prior to the cruise, download the CTDCAL Toolboxfrom the AOML intranet home page (http://doris/matlab/ctdcal/). The file ctdcal.tar.gz contains both the programs and the documentation.
The Matlab© Environment
Though the CTDCAL Toolbox, is platform independent, the following examples will assume the operating system is Linux (or some other Unix variant). As time allows, the documentation will be updated to include analogous examples on MS Windows computers.
There are several default directories which are automatically visible to the Matlab© interpreter. Upon startup, the Matlab© interpreter searches the current user's home directory, HOME, (e.g./home/user/) for a matlab/ subdirectory which is automatically appended to the Matlab© path. In this document, MATALABPATH, is used to specify the Matlab© search path.
 | NOTE: Environment Variables |
|---|---|
The enviroment variable notation (e.g. MATALABPATH) does not imply a strict association between the Matlab© search path and the Unix environment path. |
Installation
To install the CTDCAL Toolbox, simply unzip the ctdcal.tar.gz file somewhere in the MATLABPATH.
Example 1. Installing the CTDCAL Toolbox on a linux/unix computer
cp ctdcal.tar.gz ~/matlab/ cd ~/matlab/ tar xvfz ctdcal.tar.gz
There should be a ctdcal/ directory beneath the HOME/matlab/ directory, containing the program files and documentation for the CTDCAL Toolbox. This directory will be referred to as CTDCALDIR for the remainder of this document. In order to add the CTDCAL Toolbox to the default Matlab© path, add the following line to the user's startup.m file which usually exists in HOME/matlab/. The analogous directory on a Windows PC is C:\MATLAB6p5\toolbox\local\ctdcal.
path(fullfile('home','user','matlab','ctdcal'),path) % ctdcal toolbox
| NOTE |
|---|---|
Notice that the path in the above example matches the HOME/matlab/ctdcal/ directory described in the installation section. This is logical and convenient but not required. The exact form of this statement will be specific to the user's computer. |
To test the installation, start the Matlab© interpreter and type
help ctdcal
A long description of the m-files contained in the toolbox should scroll across the screen. If the Matlab© returns the message below, see the troubleshooting tips in section XX.
help ctdcal ctdcal.m not found.
Getting Help
The documentation for the CTDCAL Toolbox is contained in CTDCALDIR/doc/. There is a postscript version of this User's Guide at CTDCALDIR/doc/HOWTO-ctd-calibration.ps and an html version beginning at CTDCALDIR/doc/howto/index.html. Finally, the demo and example files, referenced throughout this document can be found in CTDCALDIR/demo/.
From within Matlab©, the help documentation for each function in the CTDCAL Toolbox can be accessed using the standard help syntax described above. In addition to the online text based help for each individual function, an html version has been created and is located at CTDCALDIR/doc/ctdcal.html. In addition to the standard help the html presentation shows the interdependencies of the Matlab© functions and the code itself.