Cf-python

-------------

**2020-07-24**

* Implemented the reading and writing of netCDF4 group hierarchies for
CF-1.8 (https://github.com/NCAS-CMS/cf-python/issues/33)
* New method: `cf.Field.nc_variable_groups`
* New method: `cf.Field.nc_set_variable_groups`
* New method: `cf.Field.nc_clear_variable_groups`
* New method: `cf.Field.nc_group_attributes`
* New method: `cf.Field.nc_set_group_attribute`
* New method: `cf.Field.nc_set_group_attributes`
* New method: `cf.Field.nc_clear_group_attributes`
* New method: `cf.Field.nc_geometry_variable_groups`
* New method: `cf.Field.nc_set_geometry_variable_groups`
* New method: `cf.Field.nc_clear_geometry_variable_groups`
* New method: `cf.DomainAxis.nc_dimension_groups`
* New method: `cf.DomainAxis.nc_set_dimension_groups`
* New method: `cf.DomainAxis.nc_clear_dimension_groups`
* New keyword parameter to `cf.write`: ``group``
* Keyword parameter ``verbose`` to multiple methods now accepts named
strings, not just the equivalent integer levels, to set verbosity.
* New function: `cf.configuration`
* Renamed to lower-case (but otherwise identical) names all functions which
get and/or set global constants: `cf.atol`, `cf.rtol`, `cf.log_level`,
`cf.chunksize`, `cf.collapse_parallel_mode`, `cf.free_memory`,
`cf.free_memory_factor`, `cf.fm_threshold`, `cf.of_fraction`,
`cf.regrid_logging`, `cf.set_performance`, `cf.tempdir`, `cf.total_memory`,
`cf.relaxed_identities`. The upper-case names remain functional as aliases.
* Changed dependency: ``cftime>=1.2.1``
* Changed dependency: ``1.8.6.0<=cfdm<1.8.7.0``
* Changed dependency: ``cfunits>=3.2.9``

----

-------------

**2020-06-10**

* Changed dependency: ``1.8.5<=cfdm<1.9.0``
* Fixed bug (emerging from the cfdm library) that prevented the
reading of certain netCDF files, such as those with at least one
external variable.

----

-------------

**2020-06-09**

* Changed the API to `cf.Field.period`: Now sets and reports on the
period of the field construct data, rather than that of its metadata
constructs.
* Enabled configuration of the extent and nature of informational and
warning messages output by `cf` using a logging framework (see
points below and also https://github.com/NCAS-CMS/cf-python/issues/37)
* Changed behaviour and default of ``verbose`` keyword argument when
available to a function/method so it interfaces with the new logging
functionality.
* Renamed and re-mapped all ``info`` keyword arguments available to any
function/method to ``verbose``, with equal granularity but a different
numbering system: ``V = I + 1`` maps ``info=I`` to ``verbose=V`` except
for the ``debug`` case of ``I=3`` mapping to ``V=-1`` (``V=0`` disables).
* New function `cf.LOG_LEVEL` to set the minimum log level for which
messages are displayed globally, i.e. to change the project-wide
verbosity.
* New method: `cf.Field.halo`
* New method: `cf.Data.halo`
* New keyword parameter to `cf.Data.empty`: ``fill_value``
* Changed dependency: ``1.8.4<=cfdm<1.9.0``
* Changed dependency: ``cfunits>=3.2.7``
* Changed dependency: ``cftime>=1.1.3``
* When assessing coordinate constructs for contiguousness with
`cf.Bounds.contiguous`, allow periodic values that differ by the
period to be considered the same
(https://github.com/NCAS-CMS/cf-python/issues/75).
* Fixed bug in `cf.Field.regrids` that caused a failure when
regridding from latitude-longitude to tripolar domains
(https://github.com/NCAS-CMS/cf-python/issues/73).
* Fixed bug in `cf.Field.regrids` that caused a failure when
regridding to tripolar domains the do not have dimension coordinate
constructs (https://github.com/NCAS-CMS/cf-python/issues/73).
* Fixed bug in `cf.Field.regrids` and `cf.Field.regridc` that caused a
failure when applying the destination mask to the regridded fields
(https://github.com/NCAS-CMS/cf-python/issues/73).
* Fixed bug that caused `cf.FieldList.select_by_ncvar` to always fail
(https://github.com/NCAS-CMS/cf-python/issues/76).
* Fixed bug that stopped 'integral' collapses working for grouped
collapses (https://github.com/NCAS-CMS/cf-python/issues/81).
* Fixed bug that wouldn't allow the reading of a netCDF file which
specifies Conventions other than CF
(https://github.com/NCAS-CMS/cf-python/issues/78).

----

-------------

**2020-04-30**

* New method: `cf.Field.apply_masking`
* New method: `cf.Data.apply_masking`
* New method: `cf.Field.get_filenames` (replaces deprecated
`cf.Field.files`)
* New method: `cf.Data.get_filenames` (replaces deprecated
`cf.Data.files`)
* New keyword parameter to `cf.read`: ``mask``
* New keyword parameter to `cf.read`: ``warn_valid``
(https://github.com/NCAS-CMS/cfdm/issues/30)
* New keyword parameter to `cf.write`: ``warn_valid``
(https://github.com/NCAS-CMS/cfdm/issues/30)
* New keyword parameter to `cf.Field.nc_global_attributes`: ``values``
* Added time coordinate bounds to the polygon geometry example field
``6`` returned by `cf.example_field`.
* Changed dependency: ``cfdm==1.8.3``
* Changed dependency: ``cfunits>=3.2.6``
* Fixed bug in `cf.write` that caused (what are effectively)
string-valued scalar auxiliary coordinates to not be written to disk
as such, or even an exception to be raised.
* Fixed bug in `cf.write` that caused the ``single`` and ``double``
keyword parameters to have no effect. This bug was introduced at
version 3.0.0 (https://github.com/NCAS-CMS/cf-python/issues/65).
* Fixed bug in `cf.Field.has_construct` that caused it to always
return `False` unless a construct key was used as the construct
identity (https://github.com/NCAS-CMS/cf-python/issues/67).

----

-------------

**2020-04-20**

* Changed the API to `cf.Field.convolution_filter`: renamed the
``weights`` parameter to ``window``.
* Reinstated `True` as a permitted value of the ``weights`` keyword of
`cf.Field.collapse` (which was deprecated at version 3.2.0).
* New method: `cf.Field.moving_window`
(https://github.com/NCAS-CMS/cf-python/issues/44)
* New method: `cf.Data.convolution_filter`
* New keyword parameter to `cf.Field.weights`: ``axes``
* New permitted values to ``coordinate`` keyword parameter of
`cf.Field.collapse` and `cf.Field.cumsum`: ``'minimum'``,
``'maximum'``
* New keyword parameter to `cf.Data.cumsum`: ``inplace``
* Fixed bug that prevented omitted the geometry type when creating
creation commands (https://github.com/NCAS-CMS/cf-python/issues/59).
* Fixed bug that caused a failure when rolling a dimension coordinate
construct without bounds.

----

-------------

**2020-04-01**

* First release for CF-1.8 (does not include netCDF hierarchical
groups functionality)
(https://github.com/NCAS-CMS/cf-python/issues/33)
* Deprecated `True` as a permitted value of the ``weights`` keyword of
`cf.Field.collapse`.
* New methods: `cf.Data.compressed`, `cf.Data.diff`
* New function: `cf.implementation`
* New methods completing coverage of the inverse trigonometric and
hyperbolic operations: `cf.Data.arccos`, `cf.Data.arccosh`,
`cf.Data.arcsin`, `cf.Data.arctanh`.
* New keyword parameters to `cf.Field.collapse`, `cf.Field.cell_area`,
`cf.Field.weights`: ``radius``, ``great_circle``.
* Implemented simple geometries for CF-1.8.
* Implemented string data-types for CF-1.8.
* Changed dependency: ``cfdm>=1.8.0``
* Changed dependency: ``cfunits>=3.2.5``
* Changed dependency: ``netCDF4>=1.5.3``
* Changed dependency: ``cftime>=1.1.1``
* Renamed the regridding method, i.e. option for the ``method``
parameter to `cf.Field.regridc` and `cf.Field.regrids`, ``bilinear``
to ``linear``, though ``bilinear`` is still supported (use of it
gives a message as such).
* Made documentation of available `cf.Field.regridc` and
`cf.Field.regrids` ``method`` parameters clearer & documented
second-order conservative method.
* Fixed bug that prevented writing to ``'NETCDF3_64BIT_OFFSET'`` and
``'NETCDF3_64BIT_DATA'`` format files
(https://github.com/NCAS-CMS/cfdm/issues/9).
* Fixed bug that prevented the ``select`` keyword of `cf.read` from
working with PP and UM files
(https://github.com/NCAS-CMS/cf-python/issues/40).
* Fixed bug that prevented the reading of PP and UM files with "zero"
data or validity times.
* Fixed broken API reference 'source' links to code in `cfdm`.
* Fixed bug in `cf.Field.weights` with the parameter ``methods`` set
to ``True`` where it would always error before returning dictionary
of methods.
* Fixed bug in `cf.Data.where` that meant the units were not taken
into account when the condition was a `cf.Query` object with
specified units.
* Addressed many 'TODO' placeholders in the documentation.

----