pywfm.IWFMBudget.get_n_locations

IWFMBudget.get_n_locations()

Return the number of locations where budget data is available.

Returns:

Number of locations.

Return type:

int

Note

e.g. if the budget file used is the stream reach budget, the number of locations is the number of stream reaches.

e.g. if the budget file used is the groundwater budget, the number of locations is the number of subregions plus one (for the entire model area).

Example

>>> from pywfm import IWFMBudget
>>> bud_file = '../Results/GW.hdf'
>>> gw_bud = IWFMBudget(bud_file)
>>> gw_bud.get_n_locations()
3
>>> gw_bud.close_budget_file()