Merge branch 'main' into density

Author: davidhassell

Changelog.rst

@@ -1,14 +1,57 @@
-version NEXTVERSION
--------------------
+version 3.17.0
+--------------
 
-**2024-??-??**
+**2025-??-??**
 
+* Set a new minimum version of `numpy`: ``2.0.0``
+  (https://github.com/NCAS-CMS/cf-python/issues/843)
+* Replace dataset aggregation functionality (CFA) with that imported
+  from `cfdm` (https://github.com/NCAS-CMS/cf-python/issues/841)
+* New keyword parameter to `cf.Field.compute_vertical_coordinates`:
+  ``key`` (https://github.com/NCAS-CMS/cf-python/issues/802)
 * New keyword parameter to `cf.histogram`: ``density``
   (https://github.com/NCAS-CMS/cf-python/issues/794)
+* Changed dependency: ``Python>=3.9.0``
+* Changed dependency: ``numpy>=2.0.0``
+* Changed dependency: ``cfdm>=1.12.0.0, <1.12.1.0``
+* Changed optional dependency: ``esmpy>=8.7.0``
+* Removed dependency (now incorporated into ``cfdm``): ``h5py``
+* Removed dependency (now incorporated into ``cfdm``): ``h5netcdf``
+* Removed dependency (now incorporated into ``cfdm``): ``s3fs``
+
+----
+
+version 3.16.3
+--------------
+
+**2025-01-28**
+
+* Allow ``'nearest_dtos'`` 2-d regridding to work with discrete
+  sampling geometry source grids
+  (https://github.com/NCAS-CMS/cf-python/issues/832)
+* New method: `cf.Field.filled`
+  (https://github.com/NCAS-CMS/cf-python/issues/811)
 * New method: `cf.Field.is_discrete_axis`
   (https://github.com/NCAS-CMS/cf-python/issues/784)
 * Include the UM version as a field property when reading UM files
   (https://github.com/NCAS-CMS/cf-python/issues/777)
+* Fix bug that caused climatological time collapses within/over days
+  to fail (https://github.com/NCAS-CMS/cf-python/issues/809)
+* New keyword parameter to `cf.Field.derivative`:
+  ``ignore_coordinate_units``
+  (https://github.com/NCAS-CMS/cf-python/issues/807)
+* Allow access to netCDF-4 files in S3 object stores
+  (https://github.com/NCAS-CMS/cf-python/issues/712)
+* New class `cf.H5netcdfArray`
+* New class `cf.NetCDF4Array`
+* New class `cf.CFAH5netcdfArray`
+* New class `cf.CFANetCDF4Array`
+* Replace core `dask` functionality with that imported from `cfdm`
+  (https://github.com/NCAS-CMS/cf-python/issues/839)
+* Fix bug that sometimes puts an incorrect ``radian-1`` or
+  ``radian-2`` in the returned units of the differential operator
+  methods and functions
+  (https://github.com/NCAS-CMS/cf-python/issues/807)
 * Fix bug where `cf.example_fields` returned a `list` of Fields rather
   than a `Fieldlist`
   (https://github.com/NCAS-CMS/cf-python/issues/725)
@@ -18,6 +61,16 @@ version NEXTVERSION
 * Fix bug where `cf.normalize_slice` doesn't correctly
   handle certain cyclic slices
   (https://github.com/NCAS-CMS/cf-python/issues/774)
+* Fix bug where `cf.Field.subspace` doesn't always correctly handle
+  global or near-global cyclic subspaces
+  (https://github.com/NCAS-CMS/cf-python/issues/828)
+* New dependency: ``h5netcdf>=1.3.0``
+* New dependency: ``h5py>=3.10.0``
+* New dependency: ``s3fs>=2024.6.0``
+* Changed dependency: ``numpy>=1.15,<2.0``
+* Changed dependency: ``1.11.2.0<=cfdm<1.11.3.0``
+* Changed dependency: ``cfunits>=3.3.7``
+* Changed dependency: ``dask>=2024.6.0,<=2024.7.1``
 
 ----
 
@@ -132,6 +185,8 @@ version 3.16.0
 * Changed dependency: ``1.11.0.0<=cfdm<1.11.1.0``
 * New dependency: ``scipy>=1.10.0``
 
+----
+
 version 3.15.4
 --------------
 
@@ -240,8 +295,8 @@ version 3.15.0
 * Handled the renaming of the ESMF Python interface from `ESMF` to
   `esmpy` at version 8.4.0. Both module names are accepted for now.
 * Changed dependency: ``1.10.1.0<=cfdm<1.10.2.0``
-* Changed (optional) dependency: ``8.0.0<=esmpy``
-* Changed (optional) dependency: ``1.10.0<=scipy``
+* Changed optional dependency: ``8.0.0<=esmpy``
+* Changed optional dependency: ``1.10.0<=scipy``
 
 ----
 
@@ -270,7 +325,7 @@ version 3.14.1
 
 ----
 
-version 3.14.0 (*first Dask release*)
+version 3.14.0 (*first Dask version*)
 -------------------------------------
 
 **2023-01-31**
@@ -305,7 +360,7 @@ version 3.14.0 (*first Dask release*)
 
 ----
 
-version 3.13.1 (*last LAMA release*)
+version 3.13.1 (*last LAMA version*)
 ------------------------------------
 
 **2022-10-17**

DOCUMENTATION.md

@@ -1,4 +1,4 @@
-* The generation of recipes using Sphinx-Gallery requires:
+* The generation of recipes using Sphinx-Gallery requires `Python<3.12.0` and:
 
   ```txt
   pip install sphinx-gallery==0.11.0
@@ -10,6 +10,7 @@
   pip install sphinxcontrib-devhelp==1.0.2
   pip install sphinxcontrib-serializinghtml==1.1.3
   pip install sphinxcontrib-qthelp==1.0.3
+  pip install sphinxcontrib.applehelp==1.0.4
   pip install alabaster==0.7.13
   pip install sphinx==2.4.5
   ```

README.md

@@ -84,7 +84,8 @@ The `cf` package uses
 [Dask](https://ncas-cms.github.io/cf-python/performance.html) for all
 of its array manipulation and can:
 
-* read field constructs from netCDF, CDL, PP and UM datasets,
+* read field constructs from netCDF, CDL, PP and UM datasets with a
+  choice of netCDF backends,and in local, http, and s3 locations,
 * create new field constructs in memory,
 * write and append field and domain constructs to netCDF datasets on disk,
 * read, create, and manipulate UGRID mesh topologies,
@@ -119,16 +120,17 @@ of its array manipulation and can:
 Visualization
 =============
 
-Powerful, flexible, and very simple to produce visualizations of field
-constructs are available with the [cfplot
-package](http://ajheaps.github.io/cf-plot), that needs to be installed
-seprately to the `cf` package.
+Powerful and flexible visualizations of `cf` field constructs,
+designed to be produced and configured in as few lines of code as
+possible, are available with the [cf-plot
+package](https://ncas-cms.github.io/cf-plot/build/index.html), which
+needs to be installed separately to the `cf` package.
 
 See the [cf-plot
-gallery](http://ajheaps.github.io/cf-plot/gallery.html) for the full
+gallery](https://ncas-cms.github.io/cf-plot/build/gallery.html) for a
 range of plotting possibilities with example code.
 
-![Example output of cf-plot displaying a `cf` field construct](docs/source/images/cfplot_example.png)
+![Example outputs of cf-plot displaying selected aspects of `cf` field constructs](https://raw.githubusercontent.com/NCAS-CMS/cf-plot/master/docs/source/images/cf_gallery_image.png)
 
 Command line utilities
 ======================