What’s New#

v0.9.0 (unreleased)#

New Features#

  • Methods for autoparsing of dataset metadata to construct a xgcm.Grid class have been added. Currently these include restructred functionality for the COMODO conventions (already in xgcm) and the addition of SGRID conventions (GH#109, GH#559). By Jack Atkinson.

Breaking Changes#

  • All computation methods on the xgcm.Axis class have been removed, in favour of using the corresponding methods on the xgcm.Grid object. The xgcm.Axis class has also been removed from public API. (GH#405, GH#557). By Thomas Nicholas.

  • All functionality for generating c-grid dimensions on incomplete datasets via xgcm.Grid.autogenerate(), was removed (GH#557).

    By Julius Busecke.

Internal Changes#

Documentation#

Bugfixes#

  • Fix bug that did not allow to create grids with faceconnections if the face dimension was coordinate-less. (GH#616, GH#616). By Julius Busecke.

  • Fix bug in xgcm.padding._maybe_rename_grid_positions() where dimensions were assumed to have coordinate values leading to errors with ECCO data. (GH#531, GH#595, GH#597). By Julius Busecke.

v0.8.1 (2022/11/22)#

New Features#

Breaking Changes#

Internal Changes#

Documentation#

  • Improved error message to suggest rechunking to a single chunk when trying to perform disallowed operations along chunked core dims. By Thomas Nicholas.

Bugfixes#

v0.8.0 (2022/06/14)#

New Features#

Breaking Changes#

Internal Changes#

Documentation#

Bugfixes#

v0.7.0 (2022/4/20)#

New Features#

  • Turn numpy-style ufuncs into grid-aware “grid-ufuncs” via new functions apply_as_grid_ufunc() and as_grid_ufunc(). (GH#362, GH#344) By Thomas Nicholas.

  • Padding of vector fields for complex topologies via a dictionary-like syntax has been added (GH#459). By Julius Busecke.

Breaking Changes#

Internal Changes#

  • All computation methods on the Grid object are now re-routed through apply_as_grid_ufunc(). By Thomas Nicholas.

Documentation#

v0.6.1 (2022/02/15)#

Documentation#

  • Switch RTD build to use mamba for increased speed and reduced memory useage (GH#401). By Julius Busecke.

Internal Changes#

v0.6.0 (2021/11/03)#

New Features#

  • set_metrics() now enables adding metrics to a grid object (GH#336, GH#199). By Dianne Deauna under the SIParCS internship.

  • get_metric() refactored, and now incorporates interp_like() to allow for automatic interpolation of missing metrics from available values on surrounding positions (GH#345, GH#354). By Dianne Deauna.[*]_

  • set_metrics() enables overwriting of previously assigned metrics to a grid object, and allows for multiple metrics on the same axes (must be different dimensions) (GH#351, GH#199). By Dianne Deauna.[*]_

  • interp_like() enables users to interpolate arrays onto the grid positions of another array, and can specify boundary conditions and fill values (GH#234 , GH#343, GH#350). By Dianne Deauna.[*]_

  • Better input checking when creating a grid object avoids creating grid positions on dataset coordinates which are not 1D (GH#208, GH#358). By Julius Busecke.

*

under the SIParCS internship <https://www2.cisl.ucar.edu/siparcs-2021-projects#8>

Breaking Changes#

Documentation#

Internal Changes#

  • Fixed metrics tests so some tests that previously did not run now do run, and refactored the metrics tests. By Tom Nicholas.[*]_

  • Enabled type checking on the repository with mypy. By Tom Nicholas.[*]_

  • Removed dependency on docrep, which as docrep 2.7 used a GPL licence, implicitly changed the license of xGCM. Therefore xGCM now has a valid MIT license, instead of accidentally being a GPL licence as it was before. (GH#308, GH#384) By Tom Nicholas.[*]_

Deprecations#

  • The keep_coords kwarg is now deprecated, and will be removed in the next version. (GH#382) By Tom Nicholas.[*]_

v0.5.2 (2021/5/27)#

Bug fixes#

Documentation#

v0.5.1 (2020/10/16)#

Bug fixes#

v0.5.0 (2020/9/28)#

New Features#

Bug fixes#

v0.4.0 (2020/9/2)#

New Features#

  • Support for keeping compatible coordinates in most Grid operations (GH#186). By Aurélien Ponte.

  • Support for specifying default boundary and fill_value in the Grid constructor. Default values can be overridden in individual method calls (e.g. Grid.interp()) as usual. By Deepak Cherian.

Bug fixes#

Internal Changes#

v0.3.0 (31 January 2020)#

This release adds support for model grid metrics , bug fixes and extended documentation.

Breaking changes#

New Features#

Bug fixes#

Documentation#

Internal Changes#

v0.2.0 (21 March 2019)#

Changes not documented for this release

v0.1.0 (13 July 2014)#

Changes not documented for this release

Initial release.