Python utilities for analyzing fully-coupled ice-ocean simulations in MOM6-IS.
xcryocouple handles the unique geometry of floating ice shelves — where MOM6's sea-surface height is depressed below sea level — and provides a clean, xarray-native API for coordinate transforms, regional masking, tracer budgets, water mass analysis, and ice mass budgets.
- Ice-shelf-aware depth coordinates — integrates layer thicknesses upward from the seafloor to correctly place layers inside sub-ice-shelf cavities
- Coordinate transforms — remap from native ALE layers to fixed depth or density (σ₀, σ₂, σ₄) coordinates
- Flux decomposition — separate bundled atmosphere/cryosphere surface fluxes into per-source terms
- Ocean tracer budgets — heat and salt budgets with fully decomposed surface flux terms
- Water mass analysis — WMT/WMB decomposition via xwmt/xwmb
- Ice mass budgets — SMB, grounding line flux, basal melt, and calving per region
- Regional masking — named ice shelf cavities, continental shelf, and user-defined regions
git clone https://github.com/hdrake/xcryocouple
cd xcryocouple
pip install -e .Requires Python ≥ 3.11. See environment.yml for a full conda environment.
PyPI and conda-forge packages are planned.
Full documentation including a user guide, worked examples, and API reference: hdrake.github.io/xcryocouple
GPLv3