Ctrl+K

imod.mf6.Modflow6Simulation.clip_box#

Modflow6Simulation.clip_box(time_min: Optional[Union[datetime, datetime64, str]] = None, time_max: Optional[Union[datetime, datetime64, str]] = None, layer_min: Optional[int] = None, layer_max: Optional[int] = None, x_min: Optional[float] = None, x_max: Optional[float] = None, y_min: Optional[float] = None, y_max: Optional[float] = None, states_for_boundary: Optional[dict[str, Union[xarray.core.dataarray.DataArray, xugrid.core.wrap.UgridDataArray]]] = None) → Modflow6Simulation[source]#

Clip a simulation by a bounding box (time, layer, y, x).

Slicing intervals may be half-bounded, by providing None:

  • To select 500.0 <= x <= 1000.0: clip_box(x_min=500.0, x_max=1000.0).

  • To select x <= 1000.0: clip_box(x_min=None, x_max=1000.0) or clip_box(x_max=1000.0).

  • To select x >= 500.0: clip_box(x_min = 500.0, x_max=None.0) or clip_box(x_min=1000.0).

Parameters

  • time_min (optional) –

  • time_max (optional) –

  • layer_min (optional, int) –

  • layer_max (optional, int) –

  • x_min (optional, float) –

  • x_max (optional, float) –

  • y_min (optional, float) –

  • y_max (optional, float) –

  • states_for_boundary (optional, Dict[pkg_name:str, boundary_values:Union[xr.DataArray, xu.UgridDataArray]]) –

Returns

clipped

Return type

Simulation

Show Source