What’s New
Contents
What’s New#
v0.9.0 (unreleased)#
New Features#
Breaking Changes#
Internal Changes#
Documentation#
Bugfixes#
v0.8.1 (2022/11/22)#
New Features#
Breaking Changes#
Internal Changes#
Rewrote cumsum to use a different code path from
apply_as_grid_ufunc()
internally, which makes it less susceptible to subtle bugs like the one reported in GH#507. (GH#558). By Thomas Nicholas.
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#
Fix bug where chunked core dims of only a single chunk triggered errors. (GH#558, GH#518, GH#522) By Thomas Nicholas.
v0.8.0 (2022/06/14)#
New Features#
Addition of logarithmic interpolation to transform (GH#483). By Jonathan Thielen.
Breaking Changes#
Internal Changes#
Switching code linting to the pre-commit.ci service (GH#490). By Julius Busecke.
Documentation#
Fix ‘suggest edits’ button in docs (GH#512, GH#503). By Julius Busecke.
Bugfixes#
Fix formatting of the CITATION.cff file (GH#500). By Julius Busecke.
Fix bug with cumsum when data chunked with dask. (GH#415, GH#507) By Thomas Nicholas.
v0.7.0 (2022/4/20)#
New Features#
Turn numpy-style ufuncs into grid-aware “grid-ufuncs” via new functions
apply_as_grid_ufunc()
andas_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#
Removed the
extrapolate
boundary option (GH#470). By Thomas Nicholas.
Internal Changes#
All computation methods on the Grid object are now re-routed through
apply_as_grid_ufunc()
. By Thomas Nicholas.
Documentation#
Switch to pangeo-book-scheme (GH#482). By Julius Busecke.
Add CITATION.cff file (GH#450). By Julius Busecke.
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#
By Julius Busecke.
Add deprecation warnings for future changes in the API (GH#409,:pull:411). By Julius Busecke.
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 incorporatesinterp_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#
Drop support for Python 3.6 (GH#360, GH#361). By Julius Busecke.
Documentation#
Added documentation on boundary conditions (GH#273, :pull: 325) By Romain Caneill.
Updated metrics documentation for new methods in Grid Metrics. By Dianne Deauna.[*]_
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#
Raise more useful errors when datasets are provided as arguments to grid.transform (GH#329, GH#328). By Julius Busecke.
Documentation#
Updated Realistic Data examples in Transforming Vertical Coordinates (GH#322) By Dianne Deauna.[*]_
Migrated model example notebooks to xgcm-examples which integrates with pangeo gallery (GH#294) By Julius Busecke.
v0.5.1 (2020/10/16)#
Bug fixes#
Add support for older numba versions (<0.49) (GH#263, GH#262). By Navid Constantinou.
v0.5.0 (2020/9/28)#
New Features#
transform()
andtransform()
now enable 1-dimensional coordinate transformation (GH#205, GH#222). By Ryan Abernathey and Julius Busecke.
Bug fixes#
More reliable handling of missing values in
Grid.average()
. Missing values between data and metrics do not have to be aligned by the user anymore. (GH#259). By Julius Busecke.Remove outdated example_notebooks folder (GH#244, GH#243). By Nikolay Koldunov and Julius Busecke.
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
andfill_value
in theGrid
constructor. Default values can be overridden in individual method calls (e.g.Grid.interp()
) as usual. By Deepak Cherian.Bug fixes
Internal Changes#
Complete refactor of the CI to github actions (GH#214). By Julius Busecke.
v0.3.0 (31 January 2020)#
This release adds support for model grid metrics , bug fixes and extended documentation.
Breaking changes#
New Features#
Support for ‘grid-aware’ average and cumsum using
average
andcumsum
(GH#162). By Julius Busecke.Support for ‘grid-aware’ integration using
integrate
(GH#130). By Julius Busecke.
Bug fixes#
Fix for broken stale build (GH#155). By Julius Busecke.
Fixed bug in handling of grid metrics. (GH#136). By Ryan Abernathey.
Fixed bug in
derivative
(GH#132). By Timothy Smith.
Documentation#
Added docs for
derivative
(GH#163) By Timothy Smith.Add binderized examples (GH#141). By Ryan Abernathey.
Simplify example notebooks (GH#140). By Ryan Abernathey.
Execute example notebook during doc build (GH#138). By Ryan Abernathey.
Added contributor guide to docs (GH#137). By Julius Busecke.
Internal Changes#
Added GitHub Action to publish xgcm to PyPI on release (GH#170). By Anderson Banihirwe.
Reorganized environment names for CI (GH#139). By Julius Busecke.
Added automatic code formatting via black (GH#131). By Julius Busecke.
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.