# doc-cache created by Octave 4.4.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: 467
 Decompress a file using a cache.

 [fname,success] = cached_decompress(filename)

 Input:
  filename: name of the file which is possibly compressed

 Output:
  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: 33
 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: 1515
 Create an array that represent a concatenated NetCDF variables.

 C = ncCatArray(dim,filenames,varname)
 C = ncCatArray(dim,pattern,varname)
 C = ncCatArray(dim,filenamefun,varname,range)
 C = ncCatArray(...,'property',value)

 create a concatenated array from variables (varname) in a list of
 netcdf files along dimension dim.Individual elements can be accessed by
 subscribs, e.g. C(2,3) and the corrsponding subset of the appropriate file is loaded

 This list of netcdf files can be specified as a cell array (filenames),
 shell wildcard pattern (e.g. file_*.nc) or a function handle
 filenamefun. In this later case, this i-th filename is
 filenamefun(range(i)).

 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.

 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).

 see also cache_decompress, ncArray
 Web: http://modb.oce.ulg.ac.be/mediawiki/index.php/ncArray



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 64
 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: 507
 Coordinates of a NetCDF variable.

 [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.
 dims is a cell-array of the dimensions of varname
 coord is 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: 34
 Coordinates of a NetCDF variable.



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 214
 Read a time variable as serial day number.
 
 t = ncreadtime(filename,varname)

 Read a time variable called varname from the file called filename as serial 
 day number (days since 31 December 1 BC, as datenum).



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 43
 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: 458
 Parse netCDF time unit.

 [t0,f] = nctimeunits(u)

 Parse the netCDF time unit u and returns the time offset (days since 31 
 December 1 BC, as datenum) and scaling factor f (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
 Also: http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/CDM/CalendarDateTime.html



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 24
 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: 43
 Test ncBaseArray, ncCatArray and ncArray.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 42
 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: 42
 Test ncBaseArray, ncCatArray and ncArray.





