Cf-python

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

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

----

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

**2020-01-17**

* Changed the API to `cf.Field.match_by_construct` and
`cf.FieldList.select_by_construct`.
* Changed the default value of the `cf.Field.collapse` ``group_span``
parameter to `True` and default value of the ``group_contiguous``
parameter to ``1``
(https://github.com/NCAS-CMS/cf-python/issues/28).
* Changed the default values of the `cf.Field.collapse` ``group_by``
and ``coordinate`` parameters to `None`.
* Changed the default value of the ``identity`` parameter to `None`
for `cf.Field.coordinate`, `cf.Field.dimension_coordinate`,
`cf.Field.auxiliary_coordinate`, `cf.Field.field_ancillary`,
`cf.Field.domain_ancillary`, `cf.Field.cell_method`,
`cf.Field.cell_measure`, `cf.Field.coordinate_reference`,
`cf.Field.domain_axis`.
* New keyword parameter to `cf.Field.weights`: ``data``.
* New keyword parameter to `cf.aggregate`: ``field_identity``
(https://github.com/NCAS-CMS/cf-python/issues/29).
* New example field (``5``) available from `cf.example_field`.
* New regridding option: ``'conservative_2nd'``.
* Fixed bug that didn't change the units of bounds when the units of
the coordinates were changed.
* Fixed bug in `cf.Field.domain_axis` that caused an error when no
unique domain axis construct could be identified.
* Changed dependency:``cfunits>=3.2.4``. This fixes a bug that raised
an exception for units specified by non-strings
(https://github.com/NCAS-CMS/cfunits/issues/1).
* Changed dependency: ``ESMF>=to 8.0.0``. This fixes an issue with
second-order conservative regridding, which is now fully documented
and available.
* Converted all remaining instances of Python 2 print statements in the
documentation API reference examples to Python 3.
* Corrected aspects of the API documentation for trigonometric functions.
* Fixed bug whereby `cf.Data.arctan` would not process bounds.
* New methods for hyperbolic operations: `cf.Data.sinh`, `cf.Data.cosh`,
`cf.Data.tanh`, `cf.Data.arcsinh`.

----

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

**2019-11-27**

* New method: `cf.Field.uncompress`.
* New method: `cf.Data.uncompress`.
* New keyword parameter to `cf.environment`: ``paths``.
* Can now insert a size 1 data dimension for a new, previously
non-existent domain axis with `cf.Field.insert_dimension`.
* Changed the default value of the ``ignore_compression`` parameter to
`True`.
* Fixed bug that sometimes gave incorrect cell sizes from the
`cellsize` attribute when used on multidimensional coordinates
(https://github.com/NCAS-CMS/cf-python/issues/15).
* Fixed bug that sometimes gave an error when the LHS and RHS operands
are swapped in field construct arithmetic
(https://github.com/NCAS-CMS/cf-python/issues/16).
* Changed dependency: ``cfdm>=1.7.11``

----

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

**2019-11-14**

* New method: `cf.Field.compress`.
* New function: `cf.example_field`
* New keyword parameter to `cf.Data`: ``mask``.
* Deprecated method: `cf.Field.example_field`
* Fixed bug that didn't allow `cf.Field.cell_area` to work with
dimension coordinates with units equivalent to metres
(https://github.com/NCAS-CMS/cf-python/issues/12)
* Fixed bug that omitted bounds having their units changed by
`override_units` and `override calendar`
(https://github.com/NCAS-CMS/cf-python/issues/13).
* Removed specific user shebang from ``cfa`` script
(https://github.com/NCAS-CMS/cf-python/pull/14).
* Changed dependency: ``cfdm>=1.7.10``. This fixes a bug that didn't
allow CDL files to start with comments or blank lines
(https://github.com/NCAS-CMS/cfdm/issues/5).
* Changed dependency: ``cftime>=1.0.4.2``

----

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

**2019-11-08**

* New methods: `cf.Field.percentile`, `cf.Field.example_field`,
`cf.Field.creation_commands`.
* New field construct collapse methods: ``median``,
``mean_of_upper_decile``.
* New method: `cf.FieldList.select_field`.
* New methods: `cf.Data.median`, `cf.Data.mean_of_upper_decile`,
`cf.Data.percentile`, `cf.Data.filled`, `cf.Data.creation_commands`.
* New keyword parameter to `cf.Data`: ``dtype``.
* Changed default ``ddof`` *back* to 1 in `cf.Data.var` and
`cf.Data.sd` (see version 3.0.3 and
https://github.com/NCAS-CMS/cf-python/issues/8)
* Fixed bug that sometimes caused an exception to be raised when
metadata constructs were selected by a property value that
legitimately contained a colon.
* Changed dependency: ``cfdm>=1.7.9``

----