# doc-cache created by Octave 11.1.0
# name: cache
# type: cell
# rows: 3
# columns: 9
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
cached_decompress


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 550
 -- FNAME = cached_decompress(FILENAME)
     Decompress a file using a cache.

     Inputs
     ......

     FILENAME: name of the file which is possibly compressed

     Outputs
     .......

     FNAME: the filename of the uncompressed file

     Global variables
     ................

     CACHED_DECOMPRESS_DIR (default is the result of tempname) cache
     directory of decompressed files.

     CACHED_DECOMPRESS_LOG_FID (default 1): file id for log message

     CACHED_DECOMPRESS_MAX_SIZE (default 1e10): maximum size of cache in
     bytes.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 32
Decompress a file using a cache.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
ncCatArray


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1826
 -- C = ncCatArray(DIM, FILENAMES, VARNAME)
 -- C = ncCatArray(DIM, PATTERN, VARNAME)
 -- C = ncCatArray(DIM, FILENAMEFUN, VARNAME, RANGE)
 -- C = ncCatArray(... PROPERTYNAME, PROPERYVALUE)
     Create an array that represent a concatenated NetCDF variables.

     Create a concatenated array from variables (varname) in a list of
     netcdf files along dimension dim.Individual elements can be
     accessed by subscripts

     e.g.  C(2,3) and the corrsponding subset of the appropriate file is
     loaded

     Inputs
     ......

     DIM - dimensions use for variables

     VARNAME - variable name to load

     FILENAMES - list of filenames as a cell array

     PATTERN - shell wildcard pattern (e.g.  file_*.nc)

     FILENAMEFUNC - a function handle where the i-th filename is
     filenamefun(range(i)).

     PROPERTYNAME, PROPERYVALUE - propery name and value pairs.

     Properties
     ..........

     'SameAttributes': false or true (default).  If SameAttribute is
     true, the variables' NetCDF attribute of all files are assumed to
     be the same.  Only the attributes of the first file is loaded in
     this case.

     Outputs
     .......

     C - a concatenated array from the read variables of the files.

     Example
     .......

          data = ncCatArray(3,{'file-20120708.nc','file-20120709.nc'},'SST')

          data = ncCatArray(3,'file-*.nc','SST')

          data = ncCatArray(3,@(t) ['file-' datestr(t,'yyyymmdd') '.nc'],'SST',...
                       datenum(2012,07,08):datenum(2012,07,09));

     Note: in Octave the glob function is used to determine files
     matching the shell wildcard pattern, while in Matlab rdir is used.
     The function rdir is available from Matlab exchange under BSD
     license
     (http://www.mathworks.com/matlabcentral/fileexchange/19550).


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 63
Create an array that represent a concatenated NetCDF variables.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 15
ncarray_example


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 28
 Tutorial for using ncArray



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 28
 Tutorial for using ncArray




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 20
ncarray_example_file


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 69
 Create an example NetCDF file with the name filename and given data



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 69
 Create an example NetCDF file with the name filename and given data




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
nccoord


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 621
 -- [DIMS, COORD] = nccoord(FILENAME, VARNAME)
     Get coordinates of the variable varname in the netcdf file called
     filename.  The netcdf is assumed to follow the CF convention.

     Inputs
     ......

     FILENAME - netcdf filename

     VARNAME - variable name

     Outputs
     .......

     DIMS - a cell-array of the dimensions of varname

     COORD - an array of structures with the field 'name' for the
     variable name, 'dims' with a cell-array of the netcdf dimensions,
     the units and NetCDF-CF standard name.

     coord is an empty structure if no coordinate information have been
     found.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 75
Get coordinates of the variable varname in the netcdf file called
filename.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
ncreadtime


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 285
 -- T = ncreadtime(FILENAME, VARNAME)
     Read a time variable as serial day number.

     Inputs
     ......

     FILENAME - netcdf filename

     VARNAME - time variable called varname.

     Outputs
     .......

     T serial day number (days since 31 December 1 BC, as datenum).


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 42
Read a time variable as serial day number.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
nctimeunits


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 528
 -- [T0, F] = nctimeunits(U)
     Parse netCDF time unit.

     Inputs
     ......

     U - netCDF time unit

     Outputs
     .......

     T0 - time offset (days since 31 December 1 BC, as datenum)

     F - scaling factor (in days)

     See the netCDF CF convention for the structure of the time units.
     <http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#time-coordinate>
     and
     <http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/CDM/CalendarDateTime.html>


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 23
Parse netCDF time unit.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
test_ncarray


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 65
 -- test_ncarray()
     Test ncBaseArray, ncCatArray and ncArray.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 41
Test ncBaseArray, ncCatArray and ncArray.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 16
test_ncarray_nan


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 43
 Test ncBaseArray, ncCatArray and ncArray.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 43
 Test ncBaseArray, ncCatArray and ncArray.






