xWMB is a Python package that provides a efficient and lazy computation of Water Mass Budgets in arbitrary sub-domains of C-grid ocean models. Most of the heavy lifting is done by dependency packages by the same team of developers:

• sectionate: for computing transports normal to a section (open or closed)
• regionate: for converting between gridded masks and the closed sections that bound them
• xbudget: for model-agnostic wrangling of multi-level tracer budgets
• xwmt: for computing bulk water mass transformations from these budgets

Documentation is not yet available, but the core API is illustrated in the example notebooks here and in each of the dependency packages.

If you use xwmb, please cite the companion manuscript: Henri Francois Drake, Shanice Bailey, Raphael Dussin, et al. Water Mass Transformation Budgets in Finite-Volume Generalized Vertical Coordinate Ocean Models. ESS Open Archive . April 11, 2024. DOI: 10.22541/essoar.171284935.57181910/v1

Minimal installation within an existing environment

pip install git+https://github.com/hdrake/xwmb.git@main

See the xwmt Quick-Start guide for instructions on configuring a conda environment from scratch.