configWRCPrograms

CONFIGWRCPROGRAMS  Configure path of the Slocum glider programs provided by WRC.

  Syntax:
    WRC_PROGS = CONFIGWRCPROGRAMS()

  Description:
    WRC_PROGS = CONFIGWRCPROGRAMS() should return a struct with the path to
    the executables provided by the Webb Research Company to deal with Slocum
    glider data files. It should have the following fields:
      DBD2ASC: path to the program to convert Slocum binary data files
        to ascii data ('dbd2asc').

    The following fields are optional. The glider processing functions do not
    use them in any way. They are here just for completeness and to allow
    using these programs from the MATLAB/Octave environment in which the
    glider processing toolbox is used.
      DBA_MERGE: path to program to merge ascii versions of the navigation
        and science files ('dba_merge').
      DBA_SENSOR_FILTER: path to program to filter data in ascii versions of
        the Slocum data files based on the source sensor ('dba_sensor_filter').
      DBA_TIME_FILTER: path to program to filter data in ascii versions of
        the Slocum data files based on the time stamp ('dba_time_filter').
      DBA2_ORIG_MATLAB: path to program to convert ascii versions of the 
        Slocum data files to MATLAB/Octave loadable files ('dba2_orig_matlab').
      RENAME_DBD_FILES: path to program to perform 8x3 DOS name format 
        renaming of the Slocum binary data files ('rename_dbd_files').

  Notes:
    The executables required are provided by the Webb Research Company and
    should be available in your system binary path as required by the
    XBD2DBA function.

  Examples:
    wrc_progs = configWRCPrograms()

  See also:
    XBD2DBA

  Authors:
    Joan Pau Beltran  <joanpau.beltran@socib.cat>

0001 function wrc_progs = configWRCPrograms()
0002 %CONFIGWRCPROGRAMS  Configure path of the Slocum glider programs provided by WRC.
0003 %
0004 %  Syntax:
0005 %    WRC_PROGS = CONFIGWRCPROGRAMS()
0006 %
0007 %  Description:
0008 %    WRC_PROGS = CONFIGWRCPROGRAMS() should return a struct with the path to
0009 %    the executables provided by the Webb Research Company to deal with Slocum
0010 %    glider data files. It should have the following fields:
0011 %      DBD2ASC: path to the program to convert Slocum binary data files
0012 %        to ascii data ('dbd2asc').
0013 %
0014 %    The following fields are optional. The glider processing functions do not
0015 %    use them in any way. They are here just for completeness and to allow
0016 %    using these programs from the MATLAB/Octave environment in which the
0017 %    glider processing toolbox is used.
0018 %      DBA_MERGE: path to program to merge ascii versions of the navigation
0019 %        and science files ('dba_merge').
0020 %      DBA_SENSOR_FILTER: path to program to filter data in ascii versions of
0021 %        the Slocum data files based on the source sensor ('dba_sensor_filter').
0022 %      DBA_TIME_FILTER: path to program to filter data in ascii versions of
0023 %        the Slocum data files based on the time stamp ('dba_time_filter').
0024 %      DBA2_ORIG_MATLAB: path to program to convert ascii versions of the
0025 %        Slocum data files to MATLAB/Octave loadable files ('dba2_orig_matlab').
0026 %      RENAME_DBD_FILES: path to program to perform 8x3 DOS name format
0027 %        renaming of the Slocum binary data files ('rename_dbd_files').
0028 %
0029 %  Notes:
0030 %    The executables required are provided by the Webb Research Company and
0031 %    should be available in your system binary path as required by the
0032 %    XBD2DBA function.
0033 %
0034 %  Examples:
0035 %    wrc_progs = configWRCPrograms()
0036 %
0037 %  See also:
0038 %    XBD2DBA
0039 %
0040 %  Authors:
0041 %    Joan Pau Beltran  <joanpau.beltran@socib.cat>
0042 
0043 %  Copyright (C) 2013-2016
0044 %  ICTS SOCIB - Servei d'observacio i prediccio costaner de les Illes Balears
0045 %  <http://www.socib.es>
0046 %
0047 %  This program is free software: you can redistribute it and/or modify
0048 %  it under the terms of the GNU General Public License as published by
0049 %  the Free Software Foundation, either version 3 of the License, or
0050 %  (at your option) any later version.
0051 %
0052 %  This program is distributed in the hope that it will be useful,
0053 %  but WITHOUT ANY WARRANTY; without even the implied warranty of
0054 %  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0055 %  GNU General Public License for more details.
0056 %
0057 %  You should have received a copy of the GNU General Public License
0058 %  along with this program.  If not, see <http://www.gnu.org/licenses/>.
0059 
0060   error(nargchk(0, 0, nargin, 'struct'));
0061   
0062   % This program is needed.
0063   wrc_progs.dbd2asc           = '/path/to/dbd2asc';
0064   % These programs are optional.
0065   wrc_progs.dba_merge         = '/path/to/dba_merge';
0066   wrc_progs.dba_sensor_filter = '/path/to/dba_sensor_filter';
0067   wrc_progs.dba_time_filter   = '/path/to/dba_time_filter';
0068   wrc_progs.dba2_orig_matlab  = '/path/to/dba2_orig_matlab';
0069   wrc_progs.rename_dbd_files  = '/path/to/rename_dbd_files';
0070 
0071 end