What’s New#

v0.8.10 (unreleased)#

v0.8.9 (Feb 06, 2023)#

  • Convert integer (e.g. 1) units to string (e.g. "1") for pint. By Justus Magin.

v0.8.8 (Jan 19, 2023)#

v0.8.7 (Dec 19, 2023)#

  • Add conversion between CF geometries and Shapely objects for lines. By Julia Signell.

v0.8.5 (Oct 24, 2023)#

v0.8.2 (July 05, 2023)#

v0.8.2 (June 23, 2023)#

v0.8.1 (May 9, 2023)#

  • Stop bundling the standard name table and use pooch (new optional dependency) to download when needed. By Deepak Cherian.

  • Major performance improvements. By Deepak Cherian.

  • Fix bug where code was looking for T axis in SGRID info. By Kristen Thyng.

  • Support X, Y for rotated pole grids. By Lars Buntemeyer.

v0.8.0 (Feb 8, 2023)#

v0.7.9 (Jan 31, 2023)#

  • Fix packaging of v0.7.8. That release was yanked off PyPI.

v0.7.8 (Jan 31, 2023)#

  • Optionally use the regex package to continue supporting global flags in regular expressions that are not at start of pattern (GH#408). By Kristen Thyng

  • Added link to docs for a new example “COSIMA ocean-sea ice model demo” (GH#397). By Aidan Heerdegen

v0.7.7 (Jan 14, 2023)#

v0.7.6 (Dec 07, 2022)#

  • Fix to cf.add_bounds to support all types of curved grids (GH#376). By Pascal Bourgault

  • Allow custom criteria to match the variable name of DataArray objects (GH#379). By Mathias Hauser

  • Support new Xarray indexes API when creating MultiIndex for “compression by gathering” datasets. (GH#381). By Deepak Cherian

v0.7.5 (Nov 15, 2022)#

v0.7.4 (July 14, 2022)#

  • Major performance improvement for __getitem_ (GH#349). By Deepak Cherian.

  • Raise warning instead of error with malformed cell_measures attributes. Warnings now print names of variables with malformed attributes (GH#350). By Deepak Cherian.

v0.7.3 (June 30, 2022)#

v0.7.2 (April 5, 2022)#

  • added encoder and decoder for writing pandas MultiIndex-es to file using “compression by gathering”. See Encoding and decoding for more. By Deepak Cherian.

  • added another type of vertical coordinate to decode: ocean_sigma_coordinate. By Kristen Thyng.

v0.7.0 (January 24, 2022)#

v0.6.3 (December 16, 2021)#

v0.6.2 (December 7, 2021)#

  • Various bug fixes.

  • New cf_xarray.geometry submodule with functions shapely_to_cf`() and cf_to_shapely() to convert between CF-compliant geometry datasets and DataArrays storing shapely geometries (new optional dependency). By Pascal Bourgault.

v0.6.1 (August 16, 2021)#

v0.6.0 (June 29, 2021)#

v0.5.2 (May 11, 2021)#

v0.5.1 (Feb 24, 2021)#

Minor bugfix release, thanks to Pascal Bourgault.

v0.5.0 (Feb 24, 2021)#

v0.4.0 (Jan 22, 2021)#

  • Support for arbitrary cell measures indexing. By Mattia Almansi.

  • Avoid using grid_latitude and grid_longitude for detecting latitude and longitude variables. By Pascal Bourgault.

v0.3.1 (Nov 25, 2020)#

v0.3.0 (Sep 27, 2020)#

This release brings changes necessary to make cf_xarray more useful with the ROMS model in particular. Thanks to Kristen Thyng for opening many issues.

  • vertical and Z are not synonyms any more. In particular, the attribute positive: up now will only match vertical and not Z. Deepak Cherian.

  • Fixed tests that would only pass if ran in a specific order. Julia Kent.

v0.2.1 (Aug 06, 2020)#

v0.2.0 (Jul 28, 2020)#


  • Begin documenting things for contributors in Contributing.

  • Parse ancillary_variables attribute. These variables are converted to coordinate variables.

  • Support Dataset.reset_index()

  • Wrap .sizes and .chunks. (GH#42) Deepak Cherian.

    >>> ds.cf.sizes
    {'X': 53, 'Y': 25, 'T': 2920, 'longitude': 53, 'latitude': 25, 'time': 2920}


  • Support indexing by standard_name

  • Set default xincrease and yincrease by interpreting the positive attribute.


  • Support expanding key to multiple dimension names.