pywfm.IWFMZBudget.get_values_for_a_zone#
- IWFMZBudget.get_values_for_a_zone(zone_id, column_ids='all', begin_date=None, end_date=None, output_interval=None, area_conversion_factor=1.0, area_units='SQ FT', volume_conversion_factor=1.0, volume_units='CU FT')#
Return specified Z-Budget data columns for a specified zone for a time period.
- Parameters:
zone_id (int) – Zone identification number used to return zbudget results.
column_ids (int, list, np.ndarray, or str='all', default 'all') – One or more column identification numbers for returning ZBudget results.
begin_date (str) – First date where zbudget results are returned.
end_date (str) – Last date where zbudget results are returned.
output_interval (str) – Output interval greater than or equal to the model simulation time step.
area_conversion_factor (float or int, default 1.0) – Factor to convert area units from the default model units to the desired output units.
area_units (str, default 'SQ FT') – output units of area
volume_conversion_factor (float or int, default 1.0) – Factor to convert volume units from the default model units to the desired output units.
volume_units (str, default 'CU FT') – output units of volume
- Returns:
DataFrame of ZBudget output for user-specified columns for a zone.
- Return type:
pd.DataFrame
Note
Return value includes Time as the first column whether the user provided it or not.
See also
IWFMZBudget.get_values_for_some_zones_for_an_intervalReturn specified zone flow values for one or more zones at a given date and time interval.
Example
>>> from pywfm import IWFMZBudget >>> zbud_file = '../Results/GW_ZBud.hdf' >>> zone_defs = '../ZBudget/ZoneDef_SRs.dat' >>> gw_zbud = IWFMZBudget(zbud_file) >>> gw_zbud.generate_zone_list_from_file(zone_defs) >>> gw_zbud.get_values_for_a_zone(1, begin_date='10/01/1997_24:00', end_date='10/31/1997_24:00', volume_conversion_factor=2.295684E-08) Time GW Storage_Inflow (+) GW Storage_Outflow (-) Streams_Inflow (+) Streams_Outflow (-) Tile Drains_Inflow (+) Tile Drains_Outflow (-) Subsidence_Inflow (+) Subsidence_Outflow (-) Deep Percolation_Inflow (+) ... Lakes_Inflow (+) Lakes_Outflow (-) Pumping by Element_Inflow (+) Pumping by Element_Outflow (-) Root Water Uptake_Inflow (+) Root Water Uptake_Outflow (-) Inflow from zone 2 (+) Outflow to zone 2 (-) Discrepancy (=) Absolute Storage 0 1997-10-01 79.117137 3.273784 2.736884 0.0 0.0 0.0 0.075730 0.000803 1.014421 ... 0.174256 0.001044 0.0 91.737228 0.0 0.0 11.439488 0.011498 6.061790e-06 12682.016587 1 1997-10-02 3.476564 6.531435 0.983505 0.0 0.0 0.0 0.000181 0.048284 1.456883 ... 0.168174 0.002426 0.0 0.000000 0.0 0.0 0.057273 0.012413 -6.353508e-09 12685.071458 2 1997-10-03 0.118540 3.098311 1.028430 0.0 0.0 0.0 0.000023 0.009861 1.333921 ... 0.144118 0.003028 0.0 0.000000 0.0 0.0 0.051278 0.017210 -6.352258e-09 12688.051229 3 1997-10-04 0.124331 3.139859 1.055758 0.0 0.0 0.0 0.000035 0.000891 1.356049 ... 0.130077 0.003131 0.0 0.000000 0.0 0.0 0.045703 0.020294 -6.350949e-09 12691.066758 4 1997-10-05 0.125371 3.137400 1.071419 0.0 0.0 0.0 0.000035 0.000828 1.345139 ... 0.122925 0.002835 0.0 0.000000 0.0 0.0 0.045204 0.021375 -6.349395e-09 12694.078787 5 1997-10-06 0.121523 3.131010 1.080384 0.0 0.0 0.0 0.000034 0.000826 1.336899 ... 0.120920 0.003890 0.0 0.000000 0.0 0.0 0.045043 0.021543 -6.346893e-09 12697.088273 6 1997-10-07 0.119390 3.127247 1.085778 0.0 0.0 0.0 0.000034 0.000825 1.331394 ... 0.119790 0.004249 0.0 0.000000 0.0 0.0 0.044929 0.021578 -6.343586e-09 12700.096130 7 1997-10-08 0.118504 3.125456 1.089236 0.0 0.0 0.0 0.000033 0.000825 1.327955 ... 0.119299 0.004664 0.0 0.000000 0.0 0.0 0.044825 0.021610 -6.329593e-09 12703.103082 8 1997-10-09 0.116697 3.121263 1.089829 0.0 0.0 0.0 0.000033 0.000824 1.325716 ... 0.119320 0.005395 0.0 0.000000 0.0 0.0 0.044724 0.021658 -8.351564e-09 12706.107648 9 1997-10-10 0.110528 3.069641 1.046827 0.0 0.0 0.0 0.000031 0.000808 1.323624 ... 0.119355 0.005760 0.0 0.000000 0.0 0.0 0.044625 0.021718 -6.412480e-09 12709.066761 10 1997-10-11 0.103343 3.019542 1.013182 0.0 0.0 0.0 0.000029 0.000792 1.310378 ... 0.121383 0.003774 0.0 0.000000 0.0 0.0 0.044529 0.021787 -6.397671e-09 12711.982960 11 1997-10-12 0.097684 2.989921 0.992680 0.0 0.0 0.0 0.000027 0.000783 1.302120 ... 0.125047 0.002714 0.0 0.000000 0.0 0.0 0.044449 0.021756 -6.392872e-09 12714.875197 12 1997-10-13 0.092270 2.977330 0.980767 0.0 0.0 0.0 0.000025 0.000779 1.303162 ... 0.127959 0.001985 0.0 0.000000 0.0 0.0 0.044371 0.021740 -6.388498e-09 12717.760257 13 1997-10-14 0.087135 2.972108 0.974152 0.0 0.0 0.0 0.000024 0.000777 1.307402 ... 0.129874 0.001615 0.0 0.000000 0.0 0.0 0.044288 0.021767 -6.380029e-09 12720.645231 14 1997-10-15 0.083334 2.970342 0.970651 0.0 0.0 0.0 0.000023 0.000777 1.311762 ... 0.130990 0.001515 0.0 0.000000 0.0 0.0 0.044203 0.021831 -6.348849e-09 12723.532238 15 1997-10-16 0.080477 2.969707 0.968900 0.0 0.0 0.0 0.000022 0.000777 1.315298 ... 0.131575 0.001592 0.0 0.000000 0.0 0.0 0.044115 0.021921 -1.389897e-09 12726.421469 16 1997-10-17 0.074166 2.947561 0.950310 0.0 0.0 0.0 0.000020 0.000770 1.318054 ... 0.131835 0.001773 0.0 0.000000 0.0 0.0 0.044025 0.022027 -6.493825e-09 12729.294864 17 1997-10-18 0.068129 2.932866 0.938721 0.0 0.0 0.0 0.000019 0.000766 1.321243 ... 0.131910 0.002013 0.0 0.000000 0.0 0.0 0.043935 0.022141 -6.458619e-09 12732.159601 18 1997-10-19 0.063871 2.928707 0.932968 0.0 0.0 0.0 0.000018 0.000764 1.327390 ... 0.131989 0.002284 0.0 0.000000 0.0 0.0 0.043845 0.022259 -6.450796e-09 12735.024437 19 1997-10-20 0.061503 2.930320 0.930234 0.0 0.0 0.0 0.000017 0.000765 1.334442 ... 0.132041 0.002569 0.0 0.000000 0.0 0.0 0.043754 0.022378 -6.445811e-09 12737.893254 20 1997-10-21 0.058493 2.932425 0.928972 0.0 0.0 0.0 0.000016 0.000766 1.341225 ... 0.132034 0.002862 0.0 0.000000 0.0 0.0 0.043663 0.022497 -6.442677e-09 12740.767185 21 1997-10-22 0.056101 2.933823 0.928477 0.0 0.0 0.0 0.000015 0.000766 1.345979 ... 0.131970 0.003159 0.0 0.000000 0.0 0.0 0.043573 0.022617 -6.438571e-09 12743.644907 22 1997-10-23 0.054233 2.934300 0.928376 0.0 0.0 0.0 0.000015 0.000767 1.348934 ... 0.131871 0.003459 0.0 0.000000 0.0 0.0 0.043482 0.022738 -6.433619e-09 12746.524974 23 1997-10-24 0.052717 2.933964 0.928475 0.0 0.0 0.0 0.000015 0.000767 1.350545 ... 0.131752 0.003760 0.0 0.000000 0.0 0.0 0.043391 0.022858 -6.426365e-09 12749.406221 24 1997-10-25 0.051644 2.933234 0.928675 0.0 0.0 0.0 0.000014 0.000767 1.351228 ... 0.131625 0.004063 0.0 0.000000 0.0 0.0 0.043301 0.022978 -6.411061e-09 12752.287811 25 1997-10-26 0.050762 2.932130 0.928925 0.0 0.0 0.0 0.000014 0.000767 1.351302 ... 0.131493 0.004366 0.0 0.000000 0.0 0.0 0.043210 0.023098 -6.363688e-09 12755.169179 26 1997-10-27 0.049930 2.930711 0.929200 0.0 0.0 0.0 0.000014 0.000767 1.350987 ... 0.131361 0.004669 0.0 0.000000 0.0 0.0 0.043120 0.023218 -5.935102e-09 12758.049960 27 1997-10-28 0.049131 2.927025 0.927415 0.0 0.0 0.0 0.000014 0.000766 1.350433 ... 0.131227 0.004973 0.0 0.000000 0.0 0.0 0.043030 0.023338 -9.135705e-09 12760.927854 28 1997-10-29 0.048360 2.913890 0.916573 0.0 0.0 0.0 0.000013 0.000762 1.349457 ... 0.131094 0.005276 0.0 0.000000 0.0 0.0 0.042940 0.023457 -6.602659e-09 12763.793384 29 1997-10-30 0.048777 2.892041 0.899888 0.0 0.0 0.0 0.000013 0.000756 1.344420 ... 0.130960 0.005580 0.0 0.000000 0.0 0.0 0.042849 0.023576 -1.509239e-08 12766.636648 30 1997-10-31 0.049344 2.846310 0.866150 0.0 0.0 0.0 0.000014 0.000742 1.332396 ... 0.130828 0.005885 0.0 0.000000 0.0 0.0 0.042759 0.023694 -6.460522e-09 12769.433613 >>> gw_zbud.close_zbudget_file()