# doc-cache created by Octave 11.2.0
# name: cache
# type: cell
# rows: 3
# columns: 10
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
import_netcdf


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 145
 -- import_fits
     Dummy function provided to provide compatibility with older versions of GNU
     Octave netcdf

     Function is deprecated.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Dummy function provided to provide compatibility with older versions of GNU
O...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
nccreate


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1425
 -- nccreate(FILENAME,VARNAME)
 -- nccreate(FILENAME,VARNAME,"property",VALUE,...)

     Create the variable VARNAME in the file FILENAME.

     Properties
     ..........

     The following properties can be used:
        • "Dimensions": a cell array with the dimension names followed by their
          length or Inf if the dimension is unlimited.  If the property is
          omitted, a scalar variable is created.
        • "Datatype": a string with the Octave data type name (see ‘ncinfo’ for
          the correspondence between Octave and NetCDF data types).  The default
          data type is a "double".
        • "Format": This can be "netcdf4_classic" (default), "classic", "64bit"
          or "netcdf4".
        • "FillValue": the value used for undefined elements of the NetCDF
          variable.
        • "ChunkSize": the size of the data chunks.  If omitted, the variable is
          not chunked.
        • "DeflateLevel": The deflate level for compression.  It can be the
          string "disable" (default) for no compression or an integer between 0
          (no compression) and 9 (maximum compression).
        • "Shuffle": true for enabling the shuffle filter or false (default) for
          disabling it.

     Example
     .......

          nccreate("test.nc","temp","Dimensions",{"lon",10,"lat",20},"Format","classic");
          ncdisp("test.nc");

     See also: ncwrite.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 49
Create the variable VARNAME in the file FILENAME.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
ncdisp


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 153
 -- ncdisp (FILENAME)
     Display meta-data of the NetCDF file FILENAME

     Example
     .......

          ncdisp("test.nc");

     See also: ncinfo.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 45
Display meta-data of the NetCDF file FILENAME



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
ncinfo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 3932
 -- INFO = ncinfo (FILENAME)
 -- INFO = ncinfo (FILENAME, VARNAME)
 -- INFO = ncinfo (FILENAME, GROUPNAME)
     Return information about an entire NetCDF file FILENAME (i.e.  the root
     group "/"), about the variable called VARNAME or the group called
     GROUPNAME.

     The structure INFO has always the following fields:
        • FILENAME: the name of the NetCDF file
        • FORMAT: one of the strings "CLASSIC", "64BIT", "NETCDF4" or
          "NETCDF4_CLASSIC"

     The structure INFO has additional fields depending on whether a group of
     variable is queried.

     Groups
     ......

     Groups are returned as an array structure with the following fields:

        • NAME: the group name.  The root group is named "/".
        • DIMENSIONS: a array structure with the dimensions.
        • VARIABLES: a array structure with the variables.
        • ATTRIBUTES: a array structure with global attributes.
        • GROUPS: a array structure (one for each group) with the same fields as
          this structure.

     Dimensions
     ..........

     Dimensions are returned as an array structure with the following fields:
        • NAME: the name of the dimension
        • LENGTH: the length of the dimension
        • UNLIMITED: true of the dimension has no fixed limited, false

     Variables
     .........

     Variables are returned as an array structure with the following fields:
        • NAME: the name of the dimension
        • DIMENSIONS: array structure of all dimensions of this variable with
          the same structure as above.
        • SIZE: array with the size of the variable
        • DATATYPE: string with the corresponding octave data-type (see below)
        • ATTRIBUTES: a array structure of attributes
        • FILLVALUE: the NetCDF fill value of the variable.  If the fill value
          is not defined, then this attribute is an empty array ([]).
        • DEFLATELEVEL: the NetCDF deflate level between 0 (no compression) and
          9 (maximum compression).
        • SHUFFLE: is true if the shuffle filter is activated to improve
          compression, otherwise false.
        • CHECKSUM: is set to "fletcher32", if check-sums are used, otherwise
          this field is not defined.

     Attributes
     ..........

     Attributes are returned as an array structure with the following fields:
        • NAME: the name of the attribute
        • VALUE: the value of the attribute (with the corresponding type)
        • UNLIMITED: true of the dimension has no fixed limited, false

     Data-types
     ..........

     The following the the correspondence between the Octave and NetCDF
     data-types:

     Octave type                              NetCDF type
     ----------------------------------------------------------------------------------
     ‘int8’                                   ‘NC_BYTE’
     ‘uint8’                                  ‘NC_UBYTE’
     ‘int16’                                  ‘NC_SHORT’
     ‘uint16’                                 ‘NC_USHORT’
     ‘int32’                                  ‘NC_INT’
     ‘uint32’                                 ‘NC_UINT’
     ‘int64’                                  ‘NC_INT64’
     ‘uint64’                                 ‘NC_UINT64’
     ‘single’                                 ‘NC_FLOAT’
     ‘double’                                 ‘NC_DOUBLE’
     ‘char’                                   ‘NC_CHAR’

     The output of ‘ncinfo’ can be used to create a NetCDF file with the same
     meta-data using ‘ncwriteschema’.

     Note: If there are no attributes (or variable or groups), the corresponding
     field is an empty matrix and not an empty struct array for compatibility
     with matlab.

     See also: ncread,nccreate,ncwriteschema,ncdisp.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Return information about an entire NetCDF file FILENAME (i.e.  the root group...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
ncread


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1395
 -- X = ncread (FILENAME, VARNAME)
 -- X = ncread (FILENAME, VARNAME,START,COUNT,STRIDE)

     Read the variable VARNAME from the NetCDF file FILENAME.

     If START,COUNT and STRIDE are present, a subset of the variable is loaded.
     The parameter START contains the starting indices (1-based), COUNT is the
     number of elements and STRIDE the increment between two successive
     elements.  These parameters are vectors whose length is equal to the number
     of dimension of the variable.  Elements of COUNT might be Inf which means
     that as many values as possible are loaded.

     If the variable has the _FillValue attribute, then the corresponding values
     are replaced by NaN (except for characters).  NetCDF attributes
     scale_factor (default 1) and add_offset (default 0) are use the transform
     the variable during the loading:

     x = scale_factor * x_in_file + add_offset

     The output data type matches the NetCDF datatype, except when the
     attributes _FillValue, add_offset or scale_factor are defined in which case
     the output is a array in double precision.

     Note that values equal to the attribute missing_value are not replaced by
     NaN (for compatibility).

     Example
     .......

     Read the data from variable 'mydata' in the file test.nc.
          data  = ncread('test.nc','mydata');

     See also: ncwrite,ncinfo,ncdisp.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 56
Read the variable VARNAME from the NetCDF file FILENAME.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
ncreadatt


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 574
 -- VAL = ncreadatt(FILENAME,VARNAME,ATTNAME)

     Return the attribute ATTNAME of the variable VARNAME in the file FILENAME.

     Global attributes can be accessed by using "/" or the group name as
     VARNAME.  The type of attribute is mapped to the Octave data types.  (see
     ‘ncinfo’).

     Example
     .......

     Read global attribute 'creation_date'
          d = ncreadatt('test.nc','/','creation_date')
     Read atribute 'myattr' assigned to variable mydata.
          d = ncreadattr('test.nc', 'mydata', 'myattr');

     See also: ncinfo,ncwriteatt.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 74
Return the attribute ATTNAME of the variable VARNAME in the file FILENAME.



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1134
 -- ncwrite (FILENAME, VARNAME, X)
 -- ncwrite (FILENAME, VARNAME, X, START, STRIDE)

     Write array X to the the variable VARNAME in the NetCDF file FILENAME.

     The variable with the name VARNAME and the appropriate dimension must
     already exist in the NetCDF file.

     If START and STRIDE are present, a subset of the variable is written.  The
     parameter START contains the starting indices (1-based) and STRIDE the
     increment between two successive elements.  These parameters are vectors
     whose length is equal to the number of dimension of the variable.

     If the variable has the _FillValue attribute, then the values equal to NaN
     are replaced by corresponding fill value NetCDF attributes scale_factor
     (default 1) and add_oddset (default 0) are use the transform the variable
     during writing:

     x_in_file = (x - add_offset)/scale_factor

     Example
     .......

     Create a netcdf file with a variable of 'mydata' and then write data to
     that variable.
          nccreate('myfile.nc','mydata');
          ncwrite('myfile.nc','mydata', 101);

     See also: ncread,nccreate.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 70
Write array X to the the variable VARNAME in the NetCDF file FILENAME.



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 588
 -- ncwriteatt(FILENAME,VARNAME,ATTNAME,VAL)

     Defines the attribute ATTNAME of the variable VARNAME in the file FILENAME
     with the value VAL.

     Global attributes can be defined by using "/" or the group name as VARNAME.
     The type of value is mapped to the NetCDF data types.  (see ‘ncinfo’).

     Example
     .......

     Create a netcdf4 format file with a variable mydata and assign an attribute
     "units" to it.
          nccreate("myfile.nc", "mydata", "Format", "netcdf4");
          ncwriteatt("myfile.nc", "mydata", "Units", "K");

     See also: ncinfo.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Defines the attribute ATTNAME of the variable VARNAME in the file FILENAME wi...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
ncwriteschema


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 835
 -- ncwriteschema (FILENAME, SCHEMA)

     Create a NetCDF called FILENAME with the dimensions, attributes, variables
     and groups given by the structure SCHEMA.

     The variable SCHEMA has the same structure as the results of ‘ncinfo’.
     ‘ncinfo’ and ‘ncwriteschema’ can be used together to create a NetCDF using
     another file as a template:

     Example
     .......

          schema = ncinfo("template.nc");
          # the new file should be named "new_file.nc"
          ncwriteschema("new_file.nc",schema);

     Unused field in SCHEMA such as CHUNKSIZE, SHUFFLE, DEFLATELEVEL, FILLVALUE,
     CHECKSUM can be left-out if the corresponding feature is not used.

     Dimensions are considered as limited if the field UNLIMITED is missing,
     unless the dimension length is Inf.

     See also: ncinfo.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Create a NetCDF called FILENAME with the dimensions, attributes, variables an...



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 72
 -- test_netcdf
     Function to do a basic test of the netcdf interface


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 51
Function to do a basic test of the netcdf interface





