parq_blockmodel.utils.temporal.demo_data.simulate_depletion_or_drawdown

parq_blockmodel.utils.temporal.demo_data.simulate_depletion_or_drawdown(variable_name, x_range, y_range, grid_size, timestamps, a, b, max_depth, center=(0.0, 0.0), delay_edges=False, netcdf_filename=None)[source]

Simulates 3D depletion or drawdown over time using an elliptical or circular footprint.

Parameters:

  • variable_name (str) – Name of the variable to simulate (e.g., ‘elevation’ or ‘water_level’).

  • x_range (Tuple[float, float]) – Tuple defining the min and max x-coordinates of the grid.

  • y_range (Tuple[float, float]) – Tuple defining the min and max y-coordinates of the grid.

  • grid_size (int) – Resolution of the grid in both x and y directions.

  • timestamps (Sequence[Timestamp]) – A list or array of pandas Timestamps for each time step.

  • a (float) – Semi-major axis of the elliptical footprint.

  • b (float) – Semi-minor axis of the elliptical footprint.

  • max_depth (float) – Maximum depth or drawdown at the center.

  • center (Tuple[float, float]) – (x0, y0) coordinates of the pit or drawdown center.

  • delay_edges (bool) – If True, applies delayed onset at the edges (for drawdown cones).

  • netcdf_filename (Optional[Path]) – Optional filepath of the NetCDF file to export the results.

Returns:

  • xarray.DataArray of shape (time_steps, y, x) with depth/drawdown values.

  • List of total volume extracted at each time step.

Return type:

A tuple containing