dev

Author: davidhassell

cf/__init__.py

@@ -288,6 +288,7 @@
     RaggedIndexedContiguousArray,
     SubsampledArray,
     UMArray,
+    ZarrArray,
 )
 
 from .aggregate import aggregate, climatology_cells

cf/read_write/read.py

@@ -152,28 +152,28 @@ class read(cfdm.read):
 
         {{read cdl_string: `bool`, optional}}
 
-        {{read external: (sequence of) `str`, optional}}
+        {{read dataset_type: `None` or (sequence of) `str`, optional}}
 
-        {{read extra: (sequence of) `str`, optional}}
+            Valid file types are:
 
-        {{read verbose: `int` or `str` or `None`, optional}}
+            ==============  ==========================================
+            *dataset_type*  Description
+            ==============  ==========================================
+            ``'netCDF'``    A netCDF-3 or netCDF-4 dataset
+            ``'CDL'``       A text CDL file of a netCDF dataset
+            ``'Zarr'``      A Zarr v2 (xarray) or Zarr v3 dataset
+            ``'UM'``        A UM fields file or PP dataset
+            ==============  ==========================================
 
-        {{read warnings: `bool`, optional}}
+            .. versionadded:: NEXTVERSION
 
-        {{read dataset_type: (sequence of) `str`, optional}}
+        {{read external: (sequence of) `str`, optional}}
 
-            Valid file types are:
+        {{read extra: (sequence of) `str`, optional}}
 
-            ============  ============================================
-            file type     Description
-            ============  ============================================
-            ``'netCDF'``  A netCDF-3 or netCDF-4 dataset
-            ``'CDL'``     A text CDL file of a netCDF dataset
-            ``'Zarr'``    A Zarr v2 (xarray-style) or Zarr v3 dataset
-            ``'UM'``      A UM fields file or PP dataset
-            ============  ============================================
+        {{read verbose: `int` or `str` or `None`, optional}}
 
-            .. versionadded:: NEXTVERSION
+        {{read warnings: `bool`, optional}}
 
         um: `dict`, optional
             For Met Office (UK) PP files and Met Office (UK) fields

docs/source/class.rst

@@ -83,6 +83,7 @@ Data classes
    cf.NetCDF4Array
    cf.FullArray
    cf.UMArray
+   cf.ZarrArray
 
 Data compression classes
 ------------------------

docs/source/class/cf.ZarrArray.rst

@@ -0,0 +1,150 @@
+.. currentmodule:: cf
+.. default-role:: obj
+
+cf.ZarrArray
+============
+
+----
+
+.. autoclass:: cf.ZarrArray
+   :no-members:
+   :no-inherited-members:
+
+Inspection
+----------
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+   
+   ~cf.ZarrArray.get_compression_type
+   ~cf.ZarrArray.get_subspace
+   ~cf.ZarrArray.get_attributes
+   ~cf.ZarrArray.index
+   ~cf.ZarrArray.is_subspace
+   
+.. rubric:: Attributes
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../attribute/
+   :template: attribute.rst
+   
+   ~cf.ZarrArray.array
+   ~cf.ZarrArray.astype
+   ~cf.ZarrArray.dtype
+   ~cf.ZarrArray.ndim
+   ~cf.ZarrArray.shape
+   ~cf.ZarrArray.size
+   ~cf.ZarrArray.original_shape
+   ~cf.ZarrArray.reference_shape
+
+Units
+-----
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+   
+   ~cf.ZarrArray.get_calendar
+   ~cf.ZarrArray.get_units
+   ~cf.ZarrArray.Units
+
+
+
+File
+----
+   
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+   
+   ~cf.ZarrArray.get_address
+   ~cf.ZarrArray.get_addresses
+   ~cf.ZarrArray.close
+   ~cf.ZarrArray.open
+   ~cf.ZarrArray.get_filename
+   ~cf.ZarrArray.get_filenames
+   ~cf.ZarrArray.get_format
+   ~cf.ZarrArray.get_formats
+   ~cf.ZarrArray.get_groups
+   ~cf.ZarrArray.get_mask
+   ~cf.ZarrArray.get_unpack
+   ~cf.ZarrArray.get_storage_options
+   ~cf.ZarrArray.add_file_location
+   ~cf.ZarrArray.del_file_location
+   ~cf.ZarrArray.file_locations
+   ~cf.ZarrArray.file_directory
+   ~cf.ZarrArray.replace_directory
+   ~cf.ZarrArray.replace_filename
+   ~cf.ZarrArray._lock
+
+   
+Miscellaneous
+-------------
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+   
+   ~cf.ZarrArray.copy
+   ~cf.ZarrArray.to_memory
+   
+Active storage
+--------------
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.ZarrArray.active_storage
+   
+Special
+-------
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+   
+   ~cf.ZarrArray.__dask_tokenize__
+   ~cf.ZarrArray.__getitem__
+
+Docstring substitutions
+-----------------------                   
+                                          
+.. rubric:: Methods                       
+                                          
+.. autosummary::                          
+   :nosignatures:                         
+   :toctree: ../method/                   
+   :template: method.rst                  
+                                          
+   ~cf.ZarrArray._docstring_special_substitutions
+   ~cf.ZarrArray._docstring_substitutions        
+   ~cf.ZarrArray._docstring_package_depth        
+   ~cf.ZarrArray._docstring_method_exclusions    
+
+Deprecated
+----------
+                                          
+.. rubric:: Methods                       
+                                          
+.. autosummary::                          
+   :nosignatures:                         
+   :toctree: ../method/                   
+   :template: method.rst                  
+
+   ~cf.ZarrArray.filename
+   ~cf.ZarrArray.get_missing_values

docs/source/conf.py

@@ -157,6 +157,7 @@ def _get_date():
     "matplotlib": ("https://matplotlib.org/stable/", None),
     # REVIEW: h5: new intersphinx mapping
     "h5netcdf": ("https://h5netcdf.org", None),
+    "zarr": ("https://zarr.readthedocs.io", None),
 }
 
 # This extension is meant to help with the common pattern of having