configRTPathsLocal

CONFIGRTPATHSLOCAL  Config local paths for glider deployment real time data and figures.

  Syntax:
    LOCAL_PATHS = CONFIGRTPATHSLOCAL()

  Description:
    LOCAL_PATHS = CONFIGDTPATHSLOCAL() should return a struct with the path 
    patterns for the deployment files involved in the glider processing chain
    in real time mode. It should have the following fields:
      BINARY_PATH: path pattern of directory of Slocum binary files (.Xbd).
      CACHE_PATH: path pattern of directory of Slocum cache files (.cac).
      LOG_PATH: path pattern of directory of Slocum surface log files (.log).
      ASCII_PATH: path pattern of directory of converted Slocum text files
        (.dba) or Seglider text files (.log and .eng).
      FIGURE_PATH: path pattern of directory for deployment figures.
      NETCDF_L0: path pattern of NetCDF file for raw data
        (data provided by the glider without any meaningful modification).
      NETCDF_L1: path pattern of NetCDF file for processed trajectory data
        (well referenced data with conversions, corrections and derivations).
      NETCDF_L2: path pattern of NetCDF file for processed grid data
        (processed data interpolated on vertical instantaneous profiles).
      PROCESSING_LOG: path pattern of processing log file.
    These path patterns are converted to true paths through the function
    STRFSTRUCT.

  Notes:
    Edit this file filling in the paths to reflect your desired file layout.

  Examples:
    local_paths = configRTPathsLocal()

  See also:
    MAIN_GLIDER_DATA_PROCESSING_RT
    STRFSTRUCT

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

0001 function local_paths = configRTPathsLocal()
0002 %CONFIGRTPATHSLOCAL  Config local paths for glider deployment real time data and figures.
0003 %
0004 %  Syntax:
0005 %    LOCAL_PATHS = CONFIGRTPATHSLOCAL()
0006 %
0007 %  Description:
0008 %    LOCAL_PATHS = CONFIGDTPATHSLOCAL() should return a struct with the path
0009 %    patterns for the deployment files involved in the glider processing chain
0010 %    in real time mode. It should have the following fields:
0011 %      BINARY_PATH: path pattern of directory of Slocum binary files (.Xbd).
0012 %      CACHE_PATH: path pattern of directory of Slocum cache files (.cac).
0013 %      LOG_PATH: path pattern of directory of Slocum surface log files (.log).
0014 %      ASCII_PATH: path pattern of directory of converted Slocum text files
0015 %        (.dba) or Seglider text files (.log and .eng).
0016 %      FIGURE_PATH: path pattern of directory for deployment figures.
0017 %      NETCDF_L0: path pattern of NetCDF file for raw data
0018 %        (data provided by the glider without any meaningful modification).
0019 %      NETCDF_L1: path pattern of NetCDF file for processed trajectory data
0020 %        (well referenced data with conversions, corrections and derivations).
0021 %      NETCDF_L2: path pattern of NetCDF file for processed grid data
0022 %        (processed data interpolated on vertical instantaneous profiles).
0023 %      PROCESSING_LOG: path pattern of processing log file.
0024 %    These path patterns are converted to true paths through the function
0025 %    STRFSTRUCT.
0026 %
0027 %  Notes:
0028 %    Edit this file filling in the paths to reflect your desired file layout.
0029 %
0030 %  Examples:
0031 %    local_paths = configRTPathsLocal()
0032 %
0033 %  See also:
0034 %    MAIN_GLIDER_DATA_PROCESSING_RT
0035 %    STRFSTRUCT
0036 %
0037 %  Authors:
0038 %    Joan Pau Beltran  <joanpau.beltran@socib.cat>
0039 
0040 %  Copyright (C) 2013-2016
0041 %  ICTS SOCIB - Servei d'observacio i prediccio costaner de les Illes Balears
0042 %  <http://www.socib.es>
0043 %
0044 %  This program is free software: you can redistribute it and/or modify
0045 %  it under the terms of the GNU General Public License as published by
0046 %  the Free Software Foundation, either version 3 of the License, or
0047 %  (at your option) any later version.
0048 %
0049 %  This program is distributed in the hope that it will be useful,
0050 %  but WITHOUT ANY WARRANTY; without even the implied warranty of
0051 %  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0052 %  GNU General Public License for more details.
0053 %
0054 %  You should have received a copy of the GNU General Public License
0055 %  along with this program.  If not, see <http://www.gnu.org/licenses/>.
0056 
0057   error(nargchk(0, 0, nargin, 'struct'));
0058 
0059   local_paths.binary_path    = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/binary';
0060   local_paths.cache_path     = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/binary';
0061   local_paths.log_path       = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/log';
0062   local_paths.ascii_path     = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/ascii';
0063   local_paths.figure_path    = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/figures';
0064   local_paths.netcdf_l0      = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/netcdf/${GLIDER_NAME}_${DEPLOYMENT_START,Tyyyymmdd}_l0.nc';
0065   local_paths.netcdf_l1      = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/netcdf/${GLIDER_NAME}_${DEPLOYMENT_START,Tyyyymmdd}_l1.nc';
0066   local_paths.netcdf_l2      = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/netcdf/${GLIDER_NAME}_${DEPLOYMENT_START,Tyyyymmdd}_l2.nc';
0067   local_paths.processing_log = '/path/to/real_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/processing.log';
0068 
0069 end