imod.prepare.cleanup_wel_layered#

imod.prepare.cleanup_wel_layered(wells: DataFrame, top: DataArray | UgridDataArray, bottom: DataArray | UgridDataArray) → DataFrame[source]#

Clean up dataframe with wells, fixes some common mistakes in the following order:

1. Wells outside grid bounds are dropped

Parameters:

• wells (pandas.Dataframe) – Dataframe with wells to be cleaned up. Requires columns "x", "y", "id"

• top (xarray.DataArray | xugrid.UgridDataArray) – Grid with model top

• bottom (xarray.DataArray | xugrid.UgridDataArray) – Grid with model bottoms

Returns:

Cleaned well dataframe.

Return type:

pandas.DataFrame