sequence.bathymetry module#

Read bathymetry.

This module contains Landlab components to read bathymetry into a SequenceModelGrid.

class sequence.bathymetry.BathymetryReader(*args, **kwds)[source]#

Bases: Component

Landlab component that reads bathymetry from a file.

__init__(grid: SequenceModelGrid, filepath: str | PathLike[str], kind: str = 'linear')[source]#

Generate a bathymetric profile from a file.

Parameters:

grid (SequenceModelGrid) – A landlab grid.
filepath (str) – Name of csv-formatted bathymetry file.
kind (str, optional) – Kind of interpolation as a string (one of ‘linear’, ‘nearest’, ‘zero’, ‘slinear’, ‘quadratic’, ‘cubic’). Default is ‘linear’.

run_one_step(dt: float | None = None) → None[source]#

Update the grid’s bathymetry.

Parameters:: dt (float, optional) – Time step to update the component by. Currently this value is unused.

property x: ndarray[Any, dtype[floating]]#: Return the x-coordinates of the grid.

property z: ndarray[Any, dtype[floating]]#: Return the elevations along the grid.