Cf-python

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

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

----

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

**2019-11-01**

* Fixed bug (introduced at v3.0.2) that caused ``mean_absolute_value``
collapses by `cf.Field.collapse` to be not weighted when they should
be (https://github.com/NCAS-CMS/cf-python/issues/9)
* Changed default ``ddof`` from 0 to 1 in `cf.Data.var` and
`cf.Data.sd` (https://github.com/NCAS-CMS/cf-python/issues/8)

----

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

**2019-10-31**

* Now reads CDL files (https://github.com/NCAS-CMS/cf-python/issues/1)
* New methods: `cf.Field.cumsum`, `cf.Field.digitize`, `cf.Field.bin`,
`cf.Field.swapaxes`, `cf.Field.flatten`, `cf.Field.radius`.
* New function: `cf.histogram`.
* New field construct collapse methods: ``integral``,
``mean_absolute_value``, ``maximum_absolute_value``,
``minimum_absolute_value``, ``sum_of_squares``,
``root_mean_square``.
* New keyword parameters to `cf.Field.collapse` and
`cf.Field.weights`: ``measure``, ``scale``, ``radius``
* New methods: `cf.Data.cumsum`, `cf.Data.digitize`,
`cf.Data.masked_all`, `cf.Data.mean_absolute_value`,
`cf.Data.maximum_absolute_value`, `cf.Data.minimum_absolute_value`,
`cf.Data.sum_of_squares`, `cf.Data.root_mean_square`,
`cf.Data.flatten`.
* Renamed `cf.default_fillvals` to `cf.default_netCDF_fillvals`.
* Changed dependency: ``cfdm>=1.7.8``. This fixes a bug that sometimes
occurs when writing to disk and the _FillValue and data have
different data types.
* Changed dependency: ``cfunits>=3.2.2``
* Changed dependency: ``cftime>=1.0.4.2``
* Fixed occasional failure to delete all temporary directories at
exit.
* Fixed bug in `cf.Data.func` when overriding units. Affects all
methods that call `cf.Data.func`, such as `cf.Data.tan` and
`cf.Field.tan`.
* Fixed "relaxed units" behaviour in `cf.aggregate` and field
construct arithmetic.
* Fixed bug that led to incorrect persistent entries in output of
`cf.Field.properties`.
* Fixed bug in `cf.Data.squeeze` that sometimes created
inconsistencies with the cyclic dimensions.
* Fixed bug in `cf.Field.mask` that assigned incorrect units to the
result.

----