tidy

Author: davidhassell

Changelog.rst

@@ -1,7 +1,18 @@
-version NEXTVERSION
--------------------
+version 3.17.0
+--------------
+
+**2025-??-??**
+
+* Replace dataset aggregation functionality (CFA) with that imported
+  from `cfdm` (https://github.com/NCAS-CMS/cf-python/issues/841)
+* Changed dependency: ``1.12.0.0<=cfdm<1.12.1.0``
+
+----
+
+version 3.16.3
+--------------
 
-**2024-12-??**
+**2025-01-28**
 
 * Allow ``'nearest_dtos'`` 2-d regridding to work with discrete
   sampling geometry source grids
@@ -24,7 +35,7 @@ version NEXTVERSION
 * New class `cf.CFAH5netcdfArray`
 * New class `cf.CFANetCDF4Array`
 * Replace core `dask` functionality with that imported from `cfdm`
-  (https://github.com/NCAS-CMS/cf-python/pull/836)
+  (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
@@ -43,9 +54,11 @@ version NEXTVERSION
   (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.2.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``
 
 ----
 

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,

cf/__init__.py

@@ -81,8 +81,8 @@
 """
 
 __Conventions__ = "CF-1.11"
-__date__ = "2024-??-??"
-__version__ = "3.17.0"
+__date__ = "2025-01-28"
+__version__ = "3.16.3"
 
 _requires = (
     "numpy",
@@ -122,7 +122,7 @@
     raise ImportError(_error0 + str(error1))
 
 try:
-    import numpy
+    import numpy as np
 except ImportError as error1:
     raise ImportError(_error0 + str(error1))
 
@@ -190,10 +190,11 @@
 
 # Check the version of numpy
 _minimum_vn = "1.22"
-if Version(numpy.__version__) < Version(_minimum_vn):
-    raise RuntimeError(
-        f"Bad numpy version: cf requires numpy>={_minimum_vn}. "
-        f"Got {numpy.__version__} at {numpy.__file__}"
+_maximum_vn = "2.0"
+if not Version(_minimum_vn) <= Version(np.__version__) < Version(_maximum_vn):
+    raise ValueError(
+        "Bad numpy version: cf requires _minimum_vn}<=numpy<{_maximum_vn}. "
+        f"Got {np.__version__} at {np.__file__}"
     )
 
 # Check the version of cfunits
@@ -211,11 +212,23 @@
 if not Version(_minimum_vn) <= _cfdm_version < Version(_maximum_vn):
     raise RuntimeError(
         f"Bad cfdm version: cf requires {_minimum_vn}<=cfdm<{_maximum_vn}. "
-        f"Got {_cfdm_version} at {cfdm.__file__}"
+        f"Got {cfdm.__version__} at {cfdm.__file__}"
     )
 
 # Check the version of dask
 
+_minimum_vn = "2024.6.1"
+_maximum_vn = "2024.7.1"
+if (
+    not Version(_minimum_vn)
+    <= Version(dask.__version__)
+    <= Version(_maximum_vn)
+):
+    raise ValueError(
+        "Bad dask version: cf requires {_minimum_vn}<=dask<={_maximum_vn}. "
+        f"Got {dask.__version__} at {dask.__file__}"
+    )
+
 # Check the version of Python
 _minimum_vn = "3.8.0"
 if Version(platform.python_version()) < Version(_minimum_vn):
@@ -232,6 +245,8 @@
         f"Got {scipy.__version__} at {scipy.__file__}"
     )
 
+del _minimum_vn, _maximum_vn
+
 from .constructs import Constructs
 
 from .mixin import Coordinate

cf/aggregate.py

@@ -3038,7 +3038,7 @@ def aggregate(
 
         unaggregatable = False
 
-        # Record the names of theaxes thatr are actually aggregated
+        # Record the names of the axes that are actually aggregated
         axes_aggregated = []
 
         for axis in aggregating_axes:

cf/data/array/aggregatedarray.py

@@ -14,7 +14,7 @@ class AggregatedArray(Container, cfdm.AggregatedArray):
     def __new__(cls, *args, **kwargs):
         """Store fragment array classes.
 
-        .. versionadded:: (cfdm) NEXTVERSION
+        .. versionadded:: NEXTVERSION
 
         """
         # Override the inherited FragmentFileArray class

cf/data/array/cfah5netcdfarray.py

@@ -0,0 +1,10 @@
+from .h5netcdfarray import H5netcdfArray
+from .mixin import CFAMixin
+
+
+class CFAH5netcdfArray(CFAMixin, H5netcdfArray):
+    """A CFA-netCDF array accessed with `h5netcdf`
+
+    .. versionadded:: 1.11.2.0
+
+    """

cf/data/array/cfanetcdf4array.py

@@ -0,0 +1,10 @@
+from .mixin import CFAMixin
+from .netcdf4array import NetCDF4Array
+
+
+class CFANetCDF4Array(CFAMixin, NetCDF4Array):
+    """A CFA-netCDF array accessed with `netCDF4`.
+
+    .. versionadded:: 1.11.2.0
+
+    """

cf/data/array/h5netcdfarray.py

@@ -16,6 +16,6 @@ class H5netcdfArray(
     An active storage reduction may be enabled with the `actify`
     method. See `cf.data.collapse.Collapse` for details.
 
-    .. versionadded:: NEXTVERSION
+    .. versionadded:: 1.11.2.0
 
     """

cf/data/array/mixin/activestoragemixin.py

@@ -1,7 +1,7 @@
 class ActiveStorageMixin:
     """Mixin class for enabling active storage operations.
 
-    .. versionadded:: NEXTVERSION
+    .. versionadded:: 1.11.2.0
 
     """
 
@@ -12,7 +12,7 @@ def active_storage(self):
         Currently, active storage operations are allowed unless the
         data are numerically packed.
 
-        .. versionadded:: NEXTVERSION
+        .. versionadded:: 1.11.2.0
 
         :Returns:
 

cf/data/array/mixin/arraymixin.py

@@ -0,0 +1,44 @@
+import numpy as np
+
+from ....units import Units
+
+
+class ArrayMixin:
+    """Mixin class for a container of an array.
+
+    .. versionadded:: 3.14.0
+
+    """
+
+    def __array_function__(self, func, types, args, kwargs):
+        """Implement the `numpy` ``__array_function__`` protocol.
+
+        .. versionadded:: 3.14.0
+
+        """
+        return NotImplemented
+
+    @property
+    def _meta(self):
+        """Normalise the array to an appropriate Dask meta object.
+
+        The Dask meta can be thought of as a suggestion to Dask. Dask
+        uses this meta to generate the task graph until it can infer
+        the actual metadata from the values. It does not force the
+        output to have the structure or dtype of the specified meta.
+
+        .. versionadded:: 1.11.2.0
+
+        .. seealso:: `dask.utils.meta_from_array`
+
+        """
+        return np.array((), dtype=self.dtype)
+
+    @property
+    def Units(self):
+        """The `cf.Units` object containing the units of the array.
+
+        .. versionadded:: 3.14.0
+
+        """
+        return Units(self.get_units(None), self.get_calendar(None))