pywfm.IWFMModel.get_depth_to_water#

IWFMModel.get_depth_to_water(layer_number, begin_date=None, end_date=None)#

calculates a depth to water for an IWFM model layer for all dates between the provided start date and end date.

Parameters:

layer_number (int) – layer number id for a given layer in an IWFM model. Must be equal to or less than total number of model layers
start_date (str, default=None) – IWFM format date for first date used to return simulated heads
end_date (str, default=None) – IWFM format date for last date used to return simulated heads

Returns:

depth to water by model node and date

Return type:

pd.DataFrame

See also

IWFMModel.get_ground_surface_elevation: Return the ground surface elevation for each node specified in the IWFM model
IWFMModel.get_gwheads_foralayer: Return the simulated groundwater heads for a single user-specified model layer for every model node over a user-specified time interval.

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_depth_to_water(1, '09/01/2000_24:00')
              Date NodeID DTW         X          Y
    0   2000-09-01      1 210.0 1804440.0 14435520.0
    1   2000-09-02      1 210.0 1804440.0 14435520.0
    2   2000-09-03      1 210.0 1804440.0 14435520.0
    3   2000-09-04      1 210.0 1804440.0 14435520.0
    4   2000-09-05      1 210.0 1804440.0 14435520.0
  ...          ...    ...   ...       ...        ...
13225   2000-09-26    441 150.0 1935672.0 14566752.0
13226   2000-09-27    441 150.0 1935672.0 14566752.0
13227   2000-09-28    441 150.0 1935672.0 14566752.0
13228   2000-09-29    441 150.0 1935672.0 14566752.0
13229   2000-09-30    441 150.0 1935672.0 14566752.0
>>> model.kill()
>>> model.close_log_file()