xbudget.collect

The public entry point: parse a recipe and evaluate it into a dataset.

collect_budgets is a thin wrapper over the typed engine (xbudget.parse.parse_budgets() then xbudget.evaluate.evaluate_budgets()). It never mutates the recipe; it only adds derived variables to the dataset. Query the result with xbudget.query.BudgetQuery.

Functions

collect_budgets(data, recipe[, ...])	Materialize every budget term described by recipe into data.
lateral_divergence(grid, Fx, Fy)	Horizontal flux divergence div(Fx, Fy) on cell centers, via xgcm.