pywfm.IWFMBudget.get_values#

IWFMBudget.get_values(location_id, columns='all', begin_date=None, end_date=None, output_interval=None, length_conversion_factor=1.0, length_units='FT', area_conversion_factor=1.0, area_units='SQ FT', volume_conversion_factor=1.0, volume_units='CU FT')#

Return budget data for selected budget columns for a location and specified time interval.

Parameters:

location_id (int) – Location identification number for budget e.g. subregion id, stream reach id, etc.
columns (str or list of str, default='all') – Column names to obtain budget data.
begin_date (str) – First date where budget data are returned.
end_date (str) – Last date where budget data are returned.
output_interval (str or None, default None) –
Valid IWFM output time interval for returning budget data.

Note

This must be greater than or equal to the simulation time step.
length_conversion_factor (float, default 1.0) – Conversion factor to convert simulation units for length to another length.
length_units (str, default 'FT') – output units of length
area_conversion_factor (float, default 1.0) – Conversion factor to convert simulation units for area.
area_units (str, default 'SQ FT') – output units of area
volume_conversion_factor (float, default 1.0) – Conversion factor to convert simulation units for volume.
volume_units (str, default 'CU FT') – output units of volume

Returns:

DataFrame containing budget data for one or more columns.

Return type:

pd.DataFrame

See also

IWFMBudget.get_values_for_a_column: Return the budget data for a single column and location for specified beginning and ending dates.

Example

>>> from pywfm import IWFMBudget
>>> bud_file = '../Results/GW.hdf'
>>> gw_bud = IWFMBudget(bud_file)
>>> gw_bud.get_values(1, ['Percolation', 'Pumping (-)'], '10/31/1999_24:00', '09/30/2000_24:00')
             Time     Percolation     Pumping (-)
  0    1999-10-31    5.409162e+06    0.000000e+00
  1    1999-11-01    5.591003e+06    0.000000e+00
  2    1999-11-02    5.774809e+06    0.000000e+00
  3    1999-11-03    5.961015e+06    0.000000e+00
  4    1999-11-04    6.161024e+06    0.000000e+00
...    ...    ...    ...
331    2000-09-26    8.134227e+05    1.905547e+07
332    2000-09-27    8.144577e+05    1.892258e+07
333    2000-09-28    8.153966e+05    1.879084e+07
334    2000-09-29    8.162175e+05    1.879133e+07
335    2000-09-30    8.168388e+05    1.879282e+07
>>> gw_bud.close_budget_file()