- fields : (arbitrarily nested sequence of) Field or FieldList
The field or fields to write to the file.
- filename : str
The output netCDF file. Various type of expansion are applied
to the file names:
| Expansion |
Description |
|---|
| Tilde |
An initial component of ~ or
~user is replaced by that user‘s
home directory. |
| Environment variable |
Substrings of the form $name or
${name} are replaced by the value
of environment variable name. |
Where more than one type of expansion is used in the same
string, they are applied in the order given in the above
table.
Example: If the environment variable MYSELF has been set
to the “david”, then '~$MYSELF/out.nc' is equivalent to
'~david/out.nc'.
- fmt : str, optional
The format of the output file. One of:
| fmt |
Description |
|---|
| 'NETCDF3_CLASSIC' |
Output to a CF-netCDF3 classic format file |
| 'NETCDF3_64BIT' |
Output to a CF-netCDF3 64-bit offset format file |
| 'NETCDF4_CLASSIC' |
Output to a CF-netCDF4 classic format file |
| 'NETCDF4' |
Output to a CF-netCDF4 format file |
| 'CFA3' |
Output to a CFA-netCDF3 classic format file |
| 'CFA4' |
Output to a CFA-netCDF4 format file |
By default the fmt is 'NETCDF3_CLASSIC'. Note that the
netCDF3 formats may be slower than any of the other options.
- overwrite: bool, optional
If False then raise an exception if the output file
pre-exists. By default a pre-existing output file is over
written.
- verbose : bool, optional
If True then print one-line summaries of each field written.
- cfa_options : dict, optional
A dictionary giving parameters for configuring the output
CFA-netCDF file:
| Key |
Value |
|---|
| 'base' |
- If None (the default) then file names
within CFA-netCDF files are stored with
absolute paths.
- If set to an empty string then file names
within CFA-netCDF files are given relative to
the directory or URL base containing the
output CFA-netCDF file.
- If set to a string then file names within
CFA-netCDF files are given relative to the
directory or URL base described by the
value. For example: '../archive'.
|
By default no parameters are specified.
- mode : str, optional
Specify the mode of write access for the output file. One of:
| mode |
Description |
|---|
| 'w' |
Open a new file for writing to. If it exists and
overwrite is True then the file is deleted prior to
being recreated. |
By default the file is opened with write access mode 'w'.
- endian : str, optional
The endian-ness of the output file. Valid values are
'little', 'big' or 'native'. By default the output
is native endian.
- least_significant_digit : int, optional
Truncate the input field data arrays. In conjunction with
compression this produces ‘lossy’, but significantly more
efficient compression. An integer value defines the power of
ten of the smallest decimal place in unpacked data that is a
reliable value.
- compress : bool, optional
If True then the data will be compressed in the output netCDF
file using standard netCDF compression. By default there is no
compression. An exception is raised if compression is
requested for an netCDF3 output file format.
- complevel : int, optional
Regulate the speed and efficiency of the compression. Must be
an integer between 0 and 9. 1 is the fastest, but
has the lowest compression ratio; 9 is the slowest but
best compression ratio; 0 means no compression. The
default value is 4. Ignored if compress is False.
- fletcher32 : bool, optional
If True then the Fletcher32 HDF5 checksum algorithm is
activated to detect compressions errors. Ignored if compress
is False.
- no_shuffle : bool, optional
If True then the HDF5 shuffle filter (which de-interlaces a
block of data before compression by reordering the bytes by
storing the first byte of all of a variable’s values in the
chunk contiguously, followed by all the second bytes, and so
on) is turned off. By default the filter is be applied because
if the data array values are not all wildly different, using
the filter can make the data more easily compressible.
Ignored if compress is False.