configDTPathsPublic

CONFIGDTPATHSPUBLIC  Configure public product and figure paths for glider deployment delayed time data.

  Syntax:
    PUBLIC_PATHS = CONFIGDTPATHSPUBLIC()

  Description:
    PUBLIC_PATHS = CONFIGDTPATHSPUBLIC() should return a struct
    with the path patterns for the public copies of the deployment product
    files generated by the glider processing chain in delayed time mode.
    It should have the following fields:
      FIGURE_DIR: path pattern of public directory for deployment figures.
      FIGURE_URL: URL pattern pointing to public directory defined above.
      FIGURE_INCLUDE: optional string cell array with the keys of the figures 
        to be copied to the public location. If this fiels is not set, all
        generated figures are copied.
      FIGURE_EXCLUDE: optional string cell array with the keys of the figures
        to exclude from copying to the public location.
      FIGURE_INFO: path pattern of the public JSON file providing the list of 
        deployment figures with their description and their URL. 
      NETCDF_L0: path pattern of the public NetCDF file for raw data
        (data provided by the glider without any meaningful modification).
      NETCDF_L1: path pattern of the publict NetCDF file for processed
        trajectory data (well referenced data with conversions, corrections,
        and derivations).
      NETCDF_L2: path pattern of the public NetCDF file for gridded data
        (processed data interpolated on vertical instantaneous profiles).
    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:
    public_paths = configDTPathsPublic()

  See also:
    MAIN_GLIDER_DATA_PROCESSING_DT
    CONFIGDTPATHSLOCAL
    STRFSTRUCT

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

0001 function public_paths = configDTPathsPublic()
0002 %CONFIGDTPATHSPUBLIC  Configure public product and figure paths for glider deployment delayed time data.
0003 %
0004 %  Syntax:
0005 %    PUBLIC_PATHS = CONFIGDTPATHSPUBLIC()
0006 %
0007 %  Description:
0008 %    PUBLIC_PATHS = CONFIGDTPATHSPUBLIC() should return a struct
0009 %    with the path patterns for the public copies of the deployment product
0010 %    files generated by the glider processing chain in delayed time mode.
0011 %    It should have the following fields:
0012 %      FIGURE_DIR: path pattern of public directory for deployment figures.
0013 %      FIGURE_URL: URL pattern pointing to public directory defined above.
0014 %      FIGURE_INCLUDE: optional string cell array with the keys of the figures
0015 %        to be copied to the public location. If this fiels is not set, all
0016 %        generated figures are copied.
0017 %      FIGURE_EXCLUDE: optional string cell array with the keys of the figures
0018 %        to exclude from copying to the public location.
0019 %      FIGURE_INFO: path pattern of the public JSON file providing the list of
0020 %        deployment figures with their description and their URL.
0021 %      NETCDF_L0: path pattern of the public NetCDF file for raw data
0022 %        (data provided by the glider without any meaningful modification).
0023 %      NETCDF_L1: path pattern of the publict NetCDF file for processed
0024 %        trajectory data (well referenced data with conversions, corrections,
0025 %        and derivations).
0026 %      NETCDF_L2: path pattern of the public NetCDF file for gridded data
0027 %        (processed data interpolated on vertical instantaneous profiles).
0028 %    These path patterns are converted to true paths through the function
0029 %    STRFSTRUCT.
0030 %
0031 %  Notes:
0032 %    Edit this file filling in the paths to reflect your desired file layout.
0033 %
0034 %  Examples:
0035 %    public_paths = configDTPathsPublic()
0036 %
0037 %  See also:
0038 %    MAIN_GLIDER_DATA_PROCESSING_DT
0039 %    CONFIGDTPATHSLOCAL
0040 %    STRFSTRUCT
0041 %
0042 %  Authors:
0043 %    Joan Pau Beltran  <joanpau.beltran@socib.cat>
0044 
0045 %  Copyright (C) 2013-2016
0046 %  ICTS SOCIB - Servei d'observacio i prediccio costaner de les Illes Balears
0047 %  <http://www.socib.es>
0048 %
0049 %  This program is free software: you can redistribute it and/or modify
0050 %  it under the terms of the GNU General Public License as published by
0051 %  the Free Software Foundation, either version 3 of the License, or
0052 %  (at your option) any later version.
0053 %
0054 %  This program is distributed in the hope that it will be useful,
0055 %  but WITHOUT ANY WARRANTY; without even the implied warranty of
0056 %  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0057 %  GNU General Public License for more details.
0058 %
0059 %  You should have received a copy of the GNU General Public License
0060 %  along with this program.  If not, see <http://www.gnu.org/licenses/>.
0061 
0062   error(nargchk(0, 0, nargin, 'struct'));
0063 
0064   public_paths.netcdf_l0   = '/path/to/public/delayed_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/netcdf/${GLIDER_NAME}_${DEPLOYMENT_START,Tyyyymmdd}_l0.nc';
0065   public_paths.netcdf_l1   = '/path/to/public/delayed_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/netcdf/${GLIDER_NAME}_${DEPLOYMENT_START,Tyyyymmdd}_l1.nc';
0066   public_paths.netcdf_l2   = '/path/to/public/delayed_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/netcdf/${GLIDER_NAME}_${DEPLOYMENT_START,Tyyyymmdd}_l2.nc';
0067   public_paths.figure_dir  = '/path/to/public/delayed_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/figures';
0068   public_paths.figure_url  = 'http://myserver/url/to/delayed_time/glider_data/${GLIDER_NAME}/${DEPLOYMENT_START,Tyyyymmdd}/figures';
0069   public_paths.figure_info = 'http://myserver/url/to/delayed_time/glider_data/figures/${DEPLOYMENT_ID}.json';
0070 
0071 end