Releases | Open Sustainable Technology

xgcm - v0.10.1

v0.10.1 (2026/07/20)

New Features

Add an experimental bipolar north-fold boundary condition for tripolar ocean grids
(MOM6, NEMO, MOM5,
Oceananigans), requested as a per-axis padding value on the fold axis, e.g.
padding={"X": "periodic", "Y": {"fold": "corner"}}. The northern edge of the logical grid
folds onto itself along the bipolar seam joining the two northern poles: the zonal axis is
mirrored about the pole and vector components reverse sign, so interp/diff/derivative
work across the Arctic seam. The pivot (center/T, corner/F, U, V) names the
staggered position the pole sits on. Only the north edge folds; the south edge of a fold
axis honours a per-call padding override when given, otherwise a configurable south
mode (default fill). This feature is experimental: its API and numerical behavior may
change, and constructing a Grid with a fold emits a UserWarning
(#194,
#711).
By Henri Drake.

Breaking Changes

Internal Changes

Documentation

Bugfixes

Climate Change - Climate Data Processing and Analysis - Python
Published by hdrake 28 days ago

xgcm - v0.10.0

What's Changed

Migrate documentation to Mkdocs, migrate dev workflow to Pixi by @VeckoTheGecko in https://github.com/xgcm/xgcm/pull/691
Improve xgcm import speed by @VeckoTheGecko in https://github.com/xgcm/xgcm/pull/697
Bugfix vector diff/interp on grids with face connections by @anthony-meza in https://github.com/xgcm/xgcm/pull/705
Fix vector diff/interp on face-connection grids with a chunked core dim (map_overlap path) by @hdrake in https://github.com/xgcm/xgcm/pull/709
Fix hash-seed-dependent / incorrect halos in face_connections padding by @hdrake in https://github.com/xgcm/xgcm/pull/713
Fix ReadTheDocs build: pin pixi to a known-good version by @hdrake in https://github.com/xgcm/xgcm/pull/715
ci: modernize the Python test matrix (fix the free-threaded 3.14 trap) by @hdrake in https://github.com/xgcm/xgcm/pull/714
Fix grid ufunc crash on dask-backed vector components (#581) by @hdrake in https://github.com/xgcm/xgcm/pull/720
Fix #496 and #575: preserve non-core input coordinates through grid operations by @hdrake in https://github.com/xgcm/xgcm/pull/721
Preserve input dimension order in apply_as_grid_ufunc (#533) by @hdrake in https://github.com/xgcm/xgcm/pull/722
ci: fix PyPI build workflow push trigger (main → master) by @hdrake in https://github.com/xgcm/xgcm/pull/740
Fix conservative-transform multi-dim guard testing dim-name length by @hdrake in https://github.com/xgcm/xgcm/pull/741
Remove Axis from the public API by @hdrake in https://github.com/xgcm/xgcm/pull/743
Adopt Intended Effort Versioning (EffVer) by @VeckoTheGecko in https://github.com/xgcm/xgcm/pull/680
docs: document the EffVer versioning policy in the contributor guide by @hdrake in https://github.com/xgcm/xgcm/pull/742
Fix vector pad ignoring rotation for bare-DataArray other_component (#748) by @hdrake in https://github.com/xgcm/xgcm/pull/749
Remove deprecated keep_coords kwarg by @hdrake in https://github.com/xgcm/xgcm/pull/745
docs/packaging: reconcile grid_ufuncs metrics note, classifiers, and drop unused future dep by @hdrake in https://github.com/xgcm/xgcm/pull/744
docs: document which pixi environment runs the doc notebooks (#667) by @hdrake in https://github.com/xgcm/xgcm/pull/750
Add reverse option to Grid.cumsum and Grid.cumint by @hdrake in https://github.com/xgcm/xgcm/pull/729
Respect fill_value set on the as_grid_ufunc decorator (fixes #652) by @gaoflow in https://github.com/xgcm/xgcm/pull/710
Raise ValueError when the same dimension is assigned to multiple Axis positions by @steps-re in https://github.com/xgcm/xgcm/pull/752
Fix spurious interpolation warnings in Grid.get_metric by @hdrake in https://github.com/xgcm/xgcm/pull/758
Document why get_metric prefers interpolating an exact-axes metric over sub-axis composition (#759) by @hdrake in https://github.com/xgcm/xgcm/pull/760
Refresh grid_metrics & transform doc notebooks; fetch grid_metrics data from Zenodo by @hdrake in https://github.com/xgcm/xgcm/pull/756
Remove the periodic argument from xgcm.Grid by @hdrake in https://github.com/xgcm/xgcm/pull/746
Rename boundary → padding throughout the API and docs (supersedes #696) by @hdrake in https://github.com/xgcm/xgcm/pull/761
docs: bump xgcm-examples submodule to modernized v0.10.0 notebooks by @hdrake in https://github.com/xgcm/xgcm/pull/763

New Contributors

@VeckoTheGecko made their first contribution in https://github.com/xgcm/xgcm/pull/688
@anthony-meza made their first contribution in https://github.com/xgcm/xgcm/pull/705
@gaoflow made their first contribution in https://github.com/xgcm/xgcm/pull/710
@steps-re made their first contribution in https://github.com/xgcm/xgcm/pull/752

Full Changelog: https://github.com/xgcm/xgcm/compare/v0.9.0...v0.10.0

Climate Change - Climate Data Processing and Analysis - Python
Published by hdrake about 1 month ago

xgcm - v0.9.0

What's Changed

Reduce the frequency of pre-commit autoupdates by @jbusecke in https://github.com/xgcm/xgcm/pull/563
Switch CI to micromamba by @jbusecke in https://github.com/xgcm/xgcm/pull/577
Remove computation methods on Axis class by @TomNicholas in https://github.com/xgcm/xgcm/pull/557
Enable environment caching in CI by @jbusecke in https://github.com/xgcm/xgcm/pull/580
Sgrid by @jatkinson1000 in https://github.com/xgcm/xgcm/pull/559
Bugfix for padding by @jbusecke in https://github.com/xgcm/xgcm/pull/597
Allow face connections for non-coordinate face dimension by @jbusecke in https://github.com/xgcm/xgcm/pull/615
Remove deprecated use of ds.dims by @jbusecke in https://github.com/xgcm/xgcm/pull/628
Fix broken sphinx build by @jbusecke in https://github.com/xgcm/xgcm/pull/631
Suppress warning about output_sizes parameter by @jbusecke in https://github.com/xgcm/xgcm/pull/638
Replace types-pkg-resources with types-setuptools in mypy pc hook by @jbusecke in https://github.com/xgcm/xgcm/pull/647
Refactor micomamba setup to setup-micromamba by @jbusecke in https://github.com/xgcm/xgcm/pull/646
Finish micromamba setup by @jbusecke in https://github.com/xgcm/xgcm/pull/649
Fix typo and url rendering in Contributor's Guide by @navidcy in https://github.com/xgcm/xgcm/pull/630
Remove mentions of extrapolate in docstrings by @jbusecke in https://github.com/xgcm/xgcm/pull/602
Consolidate into pyproject.toml by @jbusecke in https://github.com/xgcm/xgcm/pull/650
Renamed all instances of _connections to _face_connections by @hdrake in https://github.com/xgcm/xgcm/pull/661
Update syntax for dropping variables to get rid of xarray deprecation warning by @hdrake in https://github.com/xgcm/xgcm/pull/663
Enable vertical linear transform for spatially-varying target vertical coordinate by @NoraLoose in https://github.com/xgcm/xgcm/pull/642
Update pointer to environment.yml file and add submodule instructions to contributor guide by @hdrake in https://github.com/xgcm/xgcm/pull/664
Update publishing workflow + test python>=3.11 by @jbusecke in https://github.com/xgcm/xgcm/pull/673
Add test and fix conservative interpolation algorithm by @jbusecke in https://github.com/xgcm/xgcm/pull/635

New Contributors

@jatkinson1000 made their first contribution in https://github.com/xgcm/xgcm/pull/559
@hdrake made their first contribution in https://github.com/xgcm/xgcm/pull/661
@NoraLoose made their first contribution in https://github.com/xgcm/xgcm/pull/642

Full Changelog: https://github.com/xgcm/xgcm/compare/v0.8.1...v0.9.0

Climate Change - Climate Data Processing and Analysis - Python
Published by jbusecke 12 months ago

xgcm - v0.8.1

What's Changed

Rewrote cumsum to use a different code path from xgcm.apply_as_grid_ufunc internally,
which makes it less susceptible to subtle bugs like the one reported in #507. (#558).
@TomNicholas
Improved error message to suggest rechunking to a single chunk when trying to perform disallowed operations
along chunked core dims.
By @TomNicholas
Fix bug where chunked core dims of only a single chunk triggered errors. (#558, #518, #522)
By @TomNicholas

Climate Change - Climate Data Processing and Analysis - Python
Published by TomNicholas over 3 years ago

xgcm - v0.8.0

What's Changed

Implementation of transform with logarithmic interpolation (method='log') by @jthielen in https://github.com/xgcm/xgcm/pull/483
Add @jthielen by @jbusecke in https://github.com/xgcm/xgcm/pull/513
Fix chunked cumsum by @TomNicholas in https://github.com/xgcm/xgcm/pull/515
Sync black versions for black and blackdoc by @jbusecke in https://github.com/xgcm/xgcm/pull/488
Switch to pre commit service by @jbusecke in https://github.com/xgcm/xgcm/pull/490
Update dependencies in docs by @malmans2 in https://github.com/xgcm/xgcm/pull/493
Fix formatting by @jbusecke in https://github.com/xgcm/xgcm/pull/500
Fix repository url for button in docs by @jbusecke in https://github.com/xgcm/xgcm/pull/498
Fix docs 'suggest edits' by @jbusecke in https://github.com/xgcm/xgcm/pull/512
Preparing for 0.8.0 by @jbusecke in https://github.com/xgcm/xgcm/pull/514

New Contributors

@malmans2 made their first contribution in https://github.com/xgcm/xgcm/pull/493
@jthielen made their first contribution in https://github.com/xgcm/xgcm/pull/483

Full Changelog: https://github.com/xgcm/xgcm/compare/v0.7.0...v0.8.0

Climate Change - Climate Data Processing and Analysis - Python
Published by jbusecke about 4 years ago