Update all long descriptions across codebase/docs

Author: sadielbartholomew

README.md

@@ -84,8 +84,9 @@ 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, Zarr, PP and UM datasets with a
-  choice of netCDF backends,and in local, http, and s3 locations,
+* read field constructs from netCDF, CDL, Zarr, Kerchunk, 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 and Zarr v3
   datasets on disk, with control over HDF5 internal file metadata,
@@ -117,7 +118,7 @@ of its array manipulation and can:
 * apply convolution filters to field constructs,
 * create running means from field constructs,
 * apply differential operators to field constructs,
-* create derived quantities (such as relative vorticity).
+* create derived quantities (such as relative vorticity),
 * read and write data that are quantized to eliminate false
   precision.
 

RELEASE.md

@@ -32,7 +32,9 @@
 
 - [ ] Make sure that `README.md` is up to date.
 
-- [ ] Make sure that the `long_description` in `setup.py` is up to date.
+- [ ] Make sure that the `long_description` in `setup.py` is up to date
+      and consistent with the descriptions in the `README.md`, the
+      `__init__.py` and the `docs/source/installation.rst` page.
 
 - [ ] Make sure that `Changelog.rst` is up to date (cf version,
       cfdm dependency, date and changes).

cf/__init__.py

@@ -11,19 +11,24 @@
 The `cf` package uses `dask` for all of its array manipulation and
 can:
 
-* read field constructs from netCDF, CDL, Zarr, PP and UM datasets,
-
-* read field constructs and domain constructs from netCDF, CDL, PP and
-  UM datasets with a choice of netCDF backends,
+* read field constructs and domain constructs from netCDF, CDL,
+  Zarr, Kerchunk, PP and UM datasets with a choice of netCDF
+  backends,
 
 * read files from OPeNDAP servers and S3 object stores,
 
+* be fully flexible with respect to dataset storage chunking,
+
 * create new field constructs in memory,
 
-* write and append field constructs to netCDF datasets on disk,
+* write and append field and domain constructs to netCDF and
+  Zarr v3 datasets on disk, with control over HDF5 internal
+  file metadata,
 
 * read, write, and manipulate UGRID mesh topologies,
 
+* read, write, and manipulate HEALPix grids,
+
 * read, write, and create coordinates defined by geometry cells,
 
 * read netCDF and CDL datasets containing hierarchical groups,
@@ -50,22 +55,28 @@
 * manipulate field construct data by arithmetical and trigonometrical
   operations,
 
-* perform statistical collapses on field constructs,
+* perform weighted statistical collapses on field constructs,
+  including those with geometry cells, UGRID mesh topologies, and
+  HEALPix grids,
 
 * perform histogram, percentile and binning operations on field
   constructs,
 
-* regrid field constructs with (multi-)linear, nearest neighbour,
-  first- and second-order conservative and higher order patch recovery
-  methods,
+* regrid structured grid, UGRID, HEALPix, and DSG field constructs
+  with (multi-)linear, nearest neighbour, first- and second-order
+  conservative and higher order patch recovery methods, including 3-d
+  regridding, and large-grid support,
 
 * apply convolution filters to field constructs,
 
 * create running means from field constructs,
 
 * apply differential operators to field constructs,
 
-* create derived quantities (such as relative vorticity).
+* create derived quantities (such as relative vorticity),
+
+* read and write data that are quantized to eliminate false
+  precision.
 
 
 **Visualisation**

docs/source/introduction.rst

@@ -77,10 +77,12 @@ The `cf` package can:
 * create new field constructs in memory,
 
 * write and append field and domain constructs to netCDF and Zarr
-  datasets on disk, with control over HDF5 internal file metadata,
+  v3 datasets on disk, with control over HDF5 internal file metadata,
 
 * read, write, and manipulate UGRID mesh topologies,
 
+* read, write, and manipulate HEALPix grids,
+
 * read, write, and create coordinates defined by geometry cells,
 
 * read netCDF and CDL datasets containing hierarchical groups,
@@ -105,15 +107,17 @@ The `cf` package can:
 * manipulate field construct data by arithmetical and trigonometrical
   operations,
 
-* perform statistical collapses on field constructs,
+* perform weighted statistical collapses on field constructs,
+  including those with geometry cells, UGRID mesh topologies, and
+  HEALPix grids,
 
 * perform histogram, percentile and binning operations on field
   constructs,
 
-* regrid structured grid, mesh and DSG field constructs with
-  (multi-)linear, nearest neighbour, first- and second-order
-  conservative and higher order patch recovery methods, including
-  3-d regridding, and large-grid support,
+* regrid structured grid, UGRID, HEALPix, and DSG field constructs
+  with (multi-)linear, nearest neighbour, first- and second-order
+  conservative and higher order patch recovery methods, including 3-d
+  regridding, and large-grid support,
 
 * apply convolution filters to field constructs,
 

setup.py

@@ -178,7 +178,11 @@ def compile():
 
 The ``cf`` package can:
 
-* read field and domain constructs from netCDF, CDL, Zarr, Kerchunk, PP and UM datasets,
+* read field constructs and domain constructs from netCDF, CDL,
+  Zarr, Kerchunk, PP and UM datasets with a choice of netCDF
+  backends,
+
+* read files from OPeNDAP servers and S3 object stores,
 
 * be fully flexible with respect to dataset storage chunking,
 
@@ -214,7 +218,9 @@ def compile():
 * manipulate field construct data by arithmetical and trigonometrical
   operations,
 
-* perform statistical collapses on field constructs,
+* perform weighted statistical collapses on field constructs,
+  including those with geometry cells, UGRID mesh topologies, and
+  HEALPix grids,
 
 * perform histogram, percentile and binning operations on field
   constructs,