sequence.subsidence module#

Subside a SequenceModelGrid.

class sequence.subsidence.SubsidenceTimeSeries(*args, **kwds)[source]#

Bases: Component

A Landlab component that subsides a grid.

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

Create a grid subsider from a time-series file.

Parameters:

  • grid (SequenceModelGrid) – A landlab grid.

  • filepath (os.PathLike) – Name of csv-formatted subsidence file.

  • kind (str, optional) – Kind of interpolation as a string (one of ‘linear’, ‘nearest’, ‘zero’, ‘slinear’, ‘quadratic’, ‘cubic’). Default is ‘linear’.

property filepath: str#

Return the path to the current subsidence file.

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

Update the component by a time step.

Parameters:

dt (float) – The time step to update the component by.

property subsidence_rate: ndarray[Any, dtype[_ScalarType_co]]#

Return the current subsidence rate.

property time: float#

Return the current component time.