Merge branch 'main' into regrid-3d

Author: davidhassell

Changelog.rst

@@ -1,5 +1,5 @@
-version 3.17.0
---------------
+version NEXT
+------------
 
 **2024-??-??**
 
@@ -10,6 +10,18 @@ version 3.17.0
   `cf.Field.regrids` and `cf.Field.regridc`
   (https://github.com/NCAS-CMS/cf-python/issues/715)
 * Allow DSG tractories with identical `trajectory_id` values to be
+* Fix misleading error message when it is not possible to create area
+  weights requested from `cf.Field.collapse`
+  (https://github.com/NCAS-CMS/cf-python/issues/731)
+
+----
+
+version 3.16.1
+--------------
+
+**2024-03-01**
+
+* Allow DSG trajectories with identical `trajectory_id` values to be
   aggregated (https://github.com/NCAS-CMS/cf-python/issues/723)
 * New methods: `cf.Field.pad_missing` and `cf.Data.pad_missing`
   (https://github.com/NCAS-CMS/cf-python/issues/717)
@@ -28,11 +40,14 @@ version 3.17.0
 * Allow `cf.Data` to be initialised with `xarray.DataAarray`
   (https://github.com/NCAS-CMS/cf-python/issues/706)
 * Fix bug that caused `cf.Field.del_file_location` to fail when
-  updating its metdata constructs
+  updating its metadata constructs
   (https://github.com/NCAS-CMS/cf-python/issues/707)
 * Fix bug that caused incorrect data arrays in some cyclic subspaces
   created by `cf.Field.subspace` and `cf.Field.__getitem__`
   (https://github.com/NCAS-CMS/cf-python/issues/713)
+* Changed dependency: ``1.11.1.0<=cfdm<1.11.2.0``
+
+----
 
 version 3.16.0
 --------------
@@ -196,8 +211,8 @@ version 3.14.1
 
 ----
 
-version 3.14.0
---------------
+version 3.14.0 (*first Dask release*)
+-------------------------------------
 
 **2023-01-31**
 
@@ -231,8 +246,8 @@ version 3.14.0
 
 ----
 
-version 3.13.1
---------------
+version 3.13.1 (*last LAMA release*)
+------------------------------------
 
 **2022-10-17**
 
@@ -832,7 +847,7 @@ version 3.0.1
 
 ----
 
-version 3.0.0 (*first Python 3 version*)
+version 3.0.0 (*first Python 3 release*)
 ----------------------------------------
 
 **2019-10-01**
@@ -849,7 +864,7 @@ version 3.0.0 (*first Python 3 version*)
 
 ----
 
-version 2.3.8 (*last Python 2 version*)
+version 2.3.8 (*last Python 2 release*)
 ---------------------------------------
 
 **2019-10-07**
@@ -1712,8 +1727,8 @@ version 0.9.6
 
 ----
 
-version 0.9.5
--------------
+version 0.9.5 (*first LAMA release*)
+------------------------------------
 
 **2012-10-01**
 
@@ -1731,7 +1746,7 @@ version 0.9.5
 
 ----
 
-version 0.9.5.dev
+version 0.9.5.dev 
 -----------------
 
 **2012-09-19**

DOCUMENTATION.md

@@ -5,7 +5,7 @@
   sphinx-copybutton==0.5.1
   sphinx-toggleprompt==0.2.0
   sphinxcontrib-spelling==4.3.0
-  serializinghtml-serializinghtml==1.1.5
+  sphinxcontrib.serializinghtml==1.1.5
   sphinx==2.4.5
 
 * The `.py` files to generate recipes are stored in `docs/source/recipes/`.

README.md

@@ -125,7 +125,7 @@ seprately to the `cf` package.
 
 See the [cf-plot
 gallery](http://ajheaps.github.io/cf-plot/gallery.html) for the full
-range range plotting possibilities with example code.
+range of plotting possibilities with example code.
 
 ![Example output of cf-plot displaying a `cf` field construct](docs/source/images/cfplot_example.png)
 

RELEASE.md

@@ -1,3 +1,7 @@
+* Decide the version name to set for the new release, by
+  heeding the Versioning Strategy (see
+  https://ncas-cms.github.io/cf-python/releases.html#versioning-strategy).
+
 * Change the version and date in `cf/__init__.py` (`__version__` and
   `__date__` variables)
 

archive_docs

@@ -0,0 +1,28 @@
+#!/bin/bash
+# --------------------------------------------------------------------
+# Create an archive copy of the documentation
+# --------------------------------------------------------------------
+set -x
+
+version=`python -c "import cf; print(cf.__version__)"`
+
+cd docs
+mkdir -p $version
+
+cp -ar \
+  objects.inv \
+  searchindex.js \
+  *.html \
+  attribute \
+  class \
+  method \
+  function \
+  recipes \
+  _downloads \
+  _images \
+  _sources \
+  _static \
+  _templates \
+  $version
+
+set +x

cf/__init__.py

@@ -74,8 +74,8 @@
 """
 
 __Conventions__ = "CF-1.11"
-__date__ = "2023-12-06"
-__version__ = "3.16.0"
+__date__ = "2023-03-01"
+__version__ = "3.16.1"
 
 _requires = (
     "numpy",
@@ -199,8 +199,8 @@
     )
 
 # Check the version of cfdm
-_minimum_vn = "1.11.0.0"
-_maximum_vn = "1.11.1.0"
+_minimum_vn = "1.11.1.0"
+_maximum_vn = "1.11.2.0"
 _cfdm_version = Version(cfdm.__version__)
 if not Version(_minimum_vn) <= _cfdm_version < Version(_maximum_vn):
     raise RuntimeError(

cf/aggregate.py

@@ -2977,11 +2977,19 @@ def aggregate(
         # ------------------------------------------------------------
         if axes is None:
             # Aggregation will be over as many axes as possible
-            aggregating_axes = meta[0].axis_ids
+            m0 = meta[0]
+            aggregating_axes = m0.axis_ids[:]
+
+            # For DSG feature types, only consider aggregating the
+            # feature dimension(s).
+            if m0.featureType:
+                for axis in aggregating_axes[:]:
+                    if not dsg_feature_type_axis(m0, axis):
+                        aggregating_axes.remove(axis)
+
             _create_hash_and_first_values(
-                meta, None, False, hfl_cache, rtol, atol
+                meta, aggregating_axes, False, hfl_cache, rtol, atol
             )
-
         else:
             # Specific aggregation axes have been selected
             aggregating_axes = []
@@ -3484,15 +3492,16 @@ def climatology_cells(
 
 
 def _create_hash_and_first_values(
-    meta, axes, donotchecknonaggregatingaxes, hfl_cache, rtol, atol
+    meta, aggregating_axes, donotchecknonaggregatingaxes, hfl_cache, rtol, atol
 ):
     """Updates each field's _Meta object.
 
     :Parameters:
 
         meta: `list` of `_Meta`
 
-        axes: `None` or `list`
+        axes: sequence
+            The identities of the possible aggregating axes.
 
         donotchecknonaggregatingaxes: `bool`
 
@@ -3509,6 +3518,9 @@ def _create_hash_and_first_values(
         field = m.field
         constructs = field.constructs.todict()
 
+        # Store the aggregating axis identities
+        m.aggregating_axes = aggregating_axes
+
         m_sort_keys = m.sort_keys
         m_sort_indices = m.sort_indices
 
@@ -3527,9 +3539,9 @@ def _create_hash_and_first_values(
         # --------------------------------------------------------
         for identity in m.axis_ids:
             if (
-                axes is not None
+                aggregating_axes is not None
                 and donotchecknonaggregatingaxes
-                and identity not in axes
+                and identity not in aggregating_axes
             ):
                 x = [None] * len(m.axis[identity]["keys"])
                 m_hash_values[identity] = x
@@ -3671,12 +3683,12 @@ def _create_hash_and_first_values(
 
                 coord = constructs[key]
 
-                axes = aux["axes"]
+                c_axes = aux["axes"]
                 canonical_axes = aux["canonical_axes"]
-                if axes != canonical_axes:
+                if c_axes != canonical_axes:
                     # Transpose the N-d auxiliary coordinate so that
                     # it has the canonical axis order
-                    iaxes = [axes.index(axis) for axis in canonical_axes]
+                    iaxes = [c_axes.index(axis) for axis in canonical_axes]
                     coord = coord.transpose(iaxes)
 
                 sort_indices, needs_sorting = _sort_indices(m, canonical_axes)
@@ -3722,14 +3734,14 @@ def _create_hash_and_first_values(
         else:
             for canonical_units, msr in m.msr.items():
                 hash_values = []
-                for key, axes, canonical_axes in zip(
+                for key, c_axes, canonical_axes in zip(
                     msr["keys"], msr["axes"], msr["canonical_axes"]
                 ):
                     cell_measure = constructs[key]
-                    if axes != canonical_axes:
+                    if c_axes != canonical_axes:
                         # Transpose the cell measure so that it has
                         # the canonical axis order
-                        iaxes = [axes.index(axis) for axis in canonical_axes]
+                        iaxes = [c_axes.index(axis) for axis in canonical_axes]
                         cell_measure = cell_measure.transpose(iaxes)
 
                     sort_indices, needs_sorting = _sort_indices(
@@ -3836,12 +3848,12 @@ def _create_hash_and_first_values(
 
                 field_anc = constructs[key]
 
-                axes = anc["axes"]
+                c_axes = anc["axes"]
                 canonical_axes = anc["canonical_axes"]
-                if axes != canonical_axes:
+                if c_axes != canonical_axes:
                     # Transpose the field ancillary so that it has the
                     # canonical axis order
-                    iaxes = [axes.index(axis) for axis in canonical_axes]
+                    iaxes = [c_axes.index(axis) for axis in canonical_axes]
                     field_anc = field_anc.transpose(iaxes)
 
                 sort_indices, needs_sorting = _sort_indices(m, canonical_axes)
@@ -3874,12 +3886,12 @@ def _create_hash_and_first_values(
 
                 domain_anc = constructs[key]
 
-                axes = anc["axes"]
+                c_axes = anc["axes"]
                 canonical_axes = anc["canonical_axes"]
-                if axes != canonical_axes:
+                if c_axes != canonical_axes:
                     # Transpose the domain ancillary so that it has
                     # the canonical axis order
-                    iaxes = [axes.index(axis) for axis in canonical_axes]
+                    iaxes = [c_axes.index(axis) for axis in canonical_axes]
                     domain_anc = domain_anc.transpose(iaxes)
 
                 sort_indices, needs_sorting = _sort_indices(m, canonical_axes)
@@ -4131,7 +4143,7 @@ def _group_fields(meta, axis, info=False):
             group is represented by a `list` of `_Meta` objects.
 
     """
-    axes = meta[0].axis_ids
+    axes = meta[0].aggregating_axes
 
     if axes:
         if axis in axes: