Merge branch 'main' into ugrid-write

Author: davidhassell

.github/workflows/run-test-suite.yml

@@ -146,8 +146,11 @@ jobs:
       # Also, it means code coverage is only generated if the test suite is
       # passing at least for that job, avoiding useless coverage reports.
       uses: codecov/codecov-action@v3
+      # Warning: GitHub Actions expressions require single-quoted strings.
+      # Double quotes will break workflow validation (even though YAML allows
+      # them). So don't change the quoting below.
       if: |
-        matrix.os == "ubuntu-latest" && matrix.python-version == "3.10"
+        matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10'
       with:
         file: |
           ${{ github.workspace }}/main/cf/test/cf_coverage_reports/coverage.xml

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
   # Use specific format-enforcing pre-commit hooks from the core library
   # with the default configuration (see pre-commit.com for documentation)
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v6.0.0
     hooks:
       - id: check-ast
       - id: debug-statements
@@ -23,7 +23,7 @@ repos:
   # (see https://black.readthedocs.io/en/stable/ for documentation and see
   # the cf-python pyproject.toml file for our custom black configuration)
   - repo: https://github.com/ambv/black
-    rev: 24.4.2
+    rev: 25.12.0
     hooks:
       - id: black
         language_version: python3
@@ -53,7 +53,7 @@ repos:
   # (see https://flake8.pycqa.org/en/latest/ for documentation and see
   # the cf-python .flake8 file for our custom flake8 configuration)
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
+    rev: 7.3.0
     hooks:
       - id: flake8
 
@@ -62,7 +62,7 @@ repos:
   # compatible with 'black' with the lines set to ensure so in the repo's
   # pyproject.toml. Other than that and the below, no extra config is required.
   - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+    rev: 7.0.0
     hooks:
       - id: isort
         name: isort (python)

Changelog.rst

@@ -1,15 +1,14 @@
-Version NEXTVERSION
+Version 3.19.0
 --------------
 
-**2026-01-??**
+**2026-01-19**
 
 * Write Zarr v3 datasets with `cf.write`
   (https://github.com/NCAS-CMS/cf-python/issues/895)
 * Read Zarr v2 and v3 datasets that contain a group hierarchy with
   `cf.read` (https://github.com/NCAS-CMS/cf-python/issues/894)
 * Reduce the time taken to import `cf`
   (https://github.com/NCAS-CMS/cf-python/issues/902)
-* New optional dependency: ``zarr>=3.1.3``
 * New function to control the creation of cached elements during data
   display: `cf.display_data`
   (https://github.com/NCAS-CMS/cf-python/issues/913)
@@ -23,7 +22,8 @@ Version NEXTVERSION
   (https://github.com/NCAS-CMS/cf-python/issues/902)
 * Reduce the time taken to import `cf`
   (https://github.com/NCAS-CMS/cf-python/issues/902)
-* Changed dependency: ``cfdm>=1.12.4.0, <1.12.5.0``
+* New optional dependency: ``zarr>=3.1.3``
+* Changed dependency: ``cfdm>=1.13.0.0, <1.13.1.0``
 
 ----
 
@@ -1214,7 +1214,6 @@ version 2.2.4
 
 version 2.2.3
 --------------
-----
 
 **2018-06-21**
 
@@ -1253,7 +1252,6 @@ version 2.2.1
 
 version 2.2.0
 -------------
-----
 
 **2018-06-04**
 
@@ -1320,7 +1318,6 @@ version 2.1.3
 
 version 2.1.2
 -------------
-----
 
 **2017-11-28**
 
@@ -1353,7 +1350,6 @@ version 2.1
 
 version 2.0.6
 -------------
-----
 
 **2017-09-28**
 

README.md

@@ -96,7 +96,6 @@ of its array manipulation and can:
 * test whether two field constructs are the same,
 * modify field construct metadata and data,
 * create subspaces of field constructs,
-* write field constructs to netCDF datasets on disk,
 * incorporate, and create, metadata stored in external files,
 * read, write, and create data that have been compressed by convention
   (i.e. ragged or gathered arrays, or coordinate arrays compressed by

RELEASE.md

@@ -26,8 +26,7 @@
 - [ ] Ensure that the requirements on dependencies & their versions
   are up-to-date and consistent in both the `requirements.txt` and in
   `docs/source/installation.rst` (paying particular attention to
-  `cfdm`); and in the `_requires` list and `Version` checks in
-  `cf/__init__.py`.
+  `cfdm`); and in the cfdm-only `Version` checks in `cf/__init__.py`.
 
 - [ ] Make sure that `README.md` is up to date.
 
@@ -40,7 +39,7 @@
   deprecated methods and keyword arguments that can be completely
   removed, i.e. those with a ``removed_at`` version that is at or
   before the version being released. Remove any reference to them in
-  the method, class, or fucntion (including, if appropriate, the
+  the method, class, or function (including, if appropriate, the
   ``@_deprecated_kwarg_check`` decorator), and remove them from the
   relevant documentation ``.rst`` files.
 
@@ -67,10 +66,6 @@
   ./test_tutorial_code
   ```
 
-- [ ] **Follow all of the steps outlined externally in [`RECIPES.md`](./RECIPES.md)**,
-  notably so that the correct Sphinx-related environment is prepared for
-  documentation building.
-  
 - [ ] Ensure that the [PDF for Cheat Sheet](docs/_downloads/cheatsheet.pdf) 
   is updated to include any API changes. The PDF is created using Canva 
   keeping in mind the colours and fonts of the website. The same could 

cf/__init__.py

@@ -85,16 +85,16 @@
 from packaging.version import Version
 
 
-__date__ = "2025-10-16"
-__version__ = "3.18.2"
+__date__ = "2026-01-19"
+__version__ = "3.19.0"
 __cf_version__ = cfdm.__cf_version__
 __Conventions__ = f"CF-{__cf_version__}"
 
 # Check the version of cfdm (this is worth doing because of the very
 # tight coupling between cf and cfdm, and the risk of bad things
 # happening at run time if the versions are mismatched).
-_minimum_vn = "1.12.3.1"
-_maximum_vn = "1.12.4.0"
+_minimum_vn = "1.13.0.0"
+_maximum_vn = "1.13.1.0"
 _cfdm_vn = Version(cfdm.__version__)
 if _cfdm_vn < Version(_minimum_vn) or _cfdm_vn >= Version(_maximum_vn):
     raise RuntimeError(

cf/functions.py

@@ -251,7 +251,7 @@ def configuration(
             The new display data option. The default is to not change
             the current behaviour.
 
-            .. versionadded:: NEXTVERSION
+            .. versionadded:: 3.19.0
 
         regrid_logging: `bool` or `Constant`, optional
             The new value (either True to enable logging or False to
@@ -1504,7 +1504,7 @@ def total_memory():
 def is_log_level_info(logger):
     """Return True if and only if log level is at least as verbose as INFO.
 
-    Deprecated at version NEXTVERSION and is no longer available. Use
+    Deprecated at version 3.19.0 and is no longer available. Use
     `cfdm.is_log_level_info` instead.
 
     .. versionadded:: 3.16.3
@@ -1525,7 +1525,7 @@ def is_log_level_info(logger):
     _DEPRECATION_ERROR_FUNCTION(
         "is_log_level_info",
         message="Use cfdm.is_log_level_info instead",
-        version="NEXTVERSION",
+        version="3.19.0",
         removed_at="5.0.0",
     )  # pragma: no cover
 

cf/read_write/read.py

@@ -318,7 +318,7 @@ class read(cfdm.read):
 
         {{read store_dataset_shards: `bool`, optional}}
 
-            .. versionadded:: NEXTVERSION
+            .. versionadded:: 3.19.0
 
         {{read cfa: `dict`, optional}}
 
@@ -334,7 +334,7 @@ class read(cfdm.read):
 
         {{read group_dimension_search: `str`, optional}}
 
-            .. versionadded:: NEXTVERSION
+            .. versionadded:: 3.19.0
 
         umversion: deprecated at version 3.0.0
             Use the *um* parameter instead.

docs/2_to_3_changes.html

@@ -6,16 +6,12 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>Incompatible differences between versions 2.x and 3.x &#8212; Documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b3523f8e" />
-    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=541523b4" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=ca3c1c84" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=e5fbc548" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
     <link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
-    <script src="_static/documentation_options.js?v=5318ce95"></script>
+    <script src="_static/documentation_options.js?v=b14d8abf"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -27,21 +23,22 @@
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
+
+  
 
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
   <div class="document">
 
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
             <p class="logo"><a href="index.html">
-              <img class="logo" src="_static/logo.svg" alt="Logo of Python cf package"/>
+              <img class="logo" src="_static/logo.svg" alt="Logo"/>
             </a></p>
 
 
 
-<h1 class="logo"><a href="index.html">cf 3.18.2</a></h1>
+<h1 class="logo"><a href="index.html">cf 3.19.0</a></h1>
 
 
 
@@ -105,11 +102,11 @@ <h3>Related Topics</h3>
 and by <a href="https://ncas.ac.uk/">NCAS</a>.
 <br>
 <br>
-<img src="_templates/logo_EC.png" height="40">
-<img src="_templates/logo_ERC.png" height="40">
-<img src="_templates/logo_NERC.png" height="40">
+<img src="_static/logo_EC.png" height="40">
+<img src="_static/logo_ERC.png" height="40">
+<img src="_static/logo_NERC.png" height="40">
 <br>
-<img src="_templates/logo_NCAS.png" height="40">
+<img src="_static/logo_NCAS.png" height="40">
         </div>
       </div>
       <div class="documentwrapper">
@@ -478,11 +475,11 @@ <h2>Changes to the  API of existing methods<a class="headerlink" href="#changes-
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2025, NCAS | Page built on 2025-10-16.
+      &#169;2026, NCAS | Page built on 2026-01-19.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.4.7</a>
-      &amp; <a href="https://github.com/sphinx-doc/alabaster">Alabaster 0.7.14</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
 
     </div>