pywfm.IWFMBudget.get_location_names#

IWFMBudget.get_location_names()#

Retrieve the location names e.g. subregion names, lake names, etc. from the open budget file.

Returns:

Names for each location.

Return type:

list

Example

>>> from pywfm import IWFMBudget
>>> bud_file = '../Results/GW.hdf'
>>> gw_bud = IWFMBudget(bud_file)
>>> gw_bud.get_location_names()
['Region1 (SR1)', 'Region2 (SR2)', 'ENTIRE MODEL AREA']
>>> gw_bud.close_budget_file()