xbudget.presets.load_preset_budget

xbudget.presets.load_preset_budget(model='MOM6')[source]

Loads preset xbudget dictionary from yaml file for supported models.

Parameters:

model (str (default "MOM6")) – Name of any recipe shipped in xbudget/recipes/ (without the .yaml suffix). Currently: “MOM6”, “MOM6_3Donly”, “MOM6_drift”, “MOM6_surface”, “ECCOV4r4_native”. Please open an Issue if you would like to contribute an xbudget yaml file for a new model–see /recipes/ for examples.

Return type:

Python dictionary

See also

load_yaml, save_yaml, xbudget.parse_budgets