xbudget.parse.parse_budgets

xbudget.parse.parse_budgets(recipe)[source]

Parse a recipe dict into {budget_name: Budget}.

Parameters:

recipe (dict) – A recipe in xbudget format (e.g. from load_preset_budget).

Return type:

dict of str -> Budget

Examples

>>> recipe = xbudget.load_preset_budget(model="MOM6")
>>> budgets = xbudget.parse_budgets(recipe)
>>> list(budgets)
['mass', 'heat', 'salt']
>>> budgets["heat"].metadata
{'lambda': 'thetao', 'surface_lambda': 'tos'}