Components#
This section contains documentation and API reference information for the following categories of components:
Hillslope geomorphology#
- LinearDiffuser: Model soil creep using “linear diffusion” transport law (no depth dependence)
- PerronNLDiffuse: Model soil creep using implicit solution to nonlinear diffusion law
- DepthDependentDiffuser: depth dependent diffusion after Johnstone and Hilley (2014)
- TransportLengthHillslopeDiffuser: Hillslope diffusion component in the style of Carretier et al. (2016), and Davy and Lague (2009)
- TaylorNonLinearDiffuser: Model non-linear soil creep after Ganti et al. (2013)
- DepthDependentTaylorDiffuser: Model depth dependent non-linear soil creep after Ganti et al. (2012) and Johnstone and Hilley (2014)
- ThresholdEroder: Threshold eroder that cuts off slopes at a given threshold slope (Sc) and assumes material to dissolve away
Fluvial geomorphology#
- FastscapeEroder: Compute fluvial erosion using stream power theory (“fastscape” algorithm)
- StreamPower: Compute fluvial erosion using stream power theory (also uses “fastscape” algorithm but provides slightly different formulation and options)
- SedDepEroder: Compute fluvial erosion using using “tools and cover” theory
- StreamPowerSmoothThresholdEroder: Compute fluvial erosion using stream power theory with a numerically smoothed threshold
- DetachmentLtdErosion: Solve stream power equations, but without stability checks
- ErosionDeposition: Fluvial erosion in the style of Davy and Lague (2009)
- Stream Power with Alluvium Conservation and Entrainment
- NetworkSedimentTransporter: Lagrangian sediment transport in a river network
- GravelRiverTransporter: bed-load transport and downstream abrasion in a network of gravel rivers
- AreaSlopeTransporter: transport-limited model of transport, erosion, and deposition in a gridded river network
- GravelBedrockEroder: rock incision, bed-load transport, and downstream abrasion in a river network
Flow routing#
- The Landlab FlowDirectors: Components for Flow Direction
- FlowAccumulator: Component to do FlowAccumulation with the FlowDirectors
- LossyFlowAccumulator: Component to accumulate flow with the FlowDirectors, while water is lost or gained downstream
- Functions to support flow accumulation
- DepressionFinderAndRouter: Handle depressions in terrain by calculating extent and drainage of “lakes”
- LakeMapperBarnes: Component to temporarily fill depressions and reroute flow across them
- PriorityFloodFlowRouter: Accumulate flow and calculate drainage area using RICHDEM
- SinkFiller: Permanently fill pits in a topography
Shallow water hydrodynamics#
- OverlandFlow: Model shallow water flow over topography using the numerical approximation of de Almeida
- OverlandFlowBates: Model shallow water flow over topography using the numerical approximation of Bates
- KinematicWaveRengers
- KinwaveImplicitOverlandFlow
- KinwaveOverlandFlowModel
- LinearDiffusionOverlandFlowRouter
- TidalFlowCalculator: Calculate cycle-averaged tidal flow velocity using method of Mariotti (2018)
Land surface hydrology#
- Radiation: Calculate solar radiation on topography given latitude, date, and time
- PotentialEvapotranspiration: Compute potential evapotranspiration
- SoilMoisture: Compute the decay of soil moisture saturation at storm-interstorm time period
- SoilInfiltrationGreenAmpt: Model infiltration of surface water according to the Green-Ampt equation
Groundwater hydrology#
Landslides#
Vegetation#
Biota#
Precipitation#
Weathering#
Subaqueous / Submarine Processes#
Generic numerical components#
Terrain Analysis#
- SteepnessFinder: Calcuate steepness and concavity indices from gridded topography
- ChiFinder: Perform chi-index analysis for gridded topography
- DrainageDensity: Calculate drainage density from topography
- Profiler: Create and plot profiles
- ChannelProfiler: Create and plot channel profiles
- TrickleDownProfiler: Create and plot trickle down profiles
- HackCalculator: Calculate Hack’s law coefficients
- HeightAboveDrainageCalculator: Calculate height above nearest drainage
Tectonics#
- Flexure: Calculate elastic lithosphere flexure under given loads (assumes uniform flexural rigidity)
- Functions used to calculate lithospheric deflection
- gFlex: Compute elastic lithosphere flexure with variable rigidity
- NormalFault: Vertical uplift of grid nodes based on a user-specified uplift time series
- ListricKinematicExtender: Simulate Extensional Tectonic Motion on a Listric Fault Plane
Fire#
Fracture Generation#
Lithology#
Two objects based on the EventLayers object exist to make it easier to deal with spatially variable lithology and associated properties. The Lithology components contain information about spatially variable lithology and connect with the Landlab model grid so that when rock is eroded or advected upward by rock uplift the values of rock propeties at the topographic surface are updated.
First is the Lithology component which is a generic object for variable lithology.
Second is LithoLayers which makes it easy to make layered rock.
Alphabetical Listing of Modules#
- ChannelProfiler: Create and plot channel profiles
- ChiFinder: Perform chi-index analysis for gridded topography
ChiFinder
ChiFinder.__init__
ChiFinder.best_fit_chi_elevation_gradient_and_intercept
ChiFinder.calculate_chi
ChiFinder.chi_indices
ChiFinder.create_chi_plot
ChiFinder.hillslope_mask
ChiFinder.integrate_chi_avg_dx
ChiFinder.integrate_chi_each_dx
ChiFinder.masked_chi_indices
ChiFinder.mean_channel_node_spacing
ChiFinder.nodes_downstream_of_channel_head
- DepthDependentDiffuser: depth dependent diffusion after Johnstone and Hilley (2014)
- DepthDependentTaylorDiffuser: Model depth dependent non-linear soil creep after Ganti et al. (2012) and Johnstone and Hilley (2014)
- DetachmentLtdErosion: Solve stream power equations, but without stability checks
- LinearDiffuser: Model soil creep using “linear diffusion” transport law (no depth dependence)
- DimensionlessDischarge: Testing thresholds of debris flows in stream segments following Tang et al.
- DrainageDensity: Calculate drainage density from topography
- ErosionDeposition: Fluvial erosion in the style of Davy and Lague (2009)
- FireGenerator: Generate random sequence of fire events
- Flexure: Calculate elastic lithosphere flexure under given loads (assumes uniform flexural rigidity)
Flexure
Flexure1D
Flexure1D.__init__
Flexure1D.alpha
Flexure1D.calc_flexure
Flexure1D.dz_at_node
Flexure1D.eet
Flexure1D.gamma_mantle
Flexure1D.gravity
Flexure1D.load_at_node
Flexure1D.method
Flexure1D.rho_mantle
Flexure1D.rho_water
Flexure1D.rigidity
Flexure1D.run_one_step
Flexure1D.subside_loads
Flexure1D.update
Flexure1D.x_at_node
Flexure1D.youngs
get_flexure_parameter
subside_point_load
- Functions used to calculate lithospheric deflection
- FlowAccumulator: Component to do FlowAccumulation with the FlowDirectors
FlowAccumulator
FlowAccumulator.__init__
FlowAccumulator.accumulate_flow
FlowAccumulator.depression_finder
FlowAccumulator.depression_handler_raster_direction_method
FlowAccumulator.flooded_nodes_present
FlowAccumulator.flow_director
FlowAccumulator.flow_director_raster_method
FlowAccumulator.headwater_nodes
FlowAccumulator.link_order_upstream
FlowAccumulator.node_drainage_area
FlowAccumulator.node_order_upstream
FlowAccumulator.node_water_discharge
FlowAccumulator.pits_present
FlowAccumulator.run_one_step
FlowAccumulator.surface_values
- LossyFlowAccumulator: Component to accumulate flow with the FlowDirectors, while water is lost or gained downstream
- Functions to support flow accumulation
- The Landlab FlowDirectors: Components for Flow Direction
- FlowDirectorSteepest
FlowDirectorSteepest
FlowDirectorSteepest.__init__
FlowDirectorSteepest.direct_flow
FlowDirectorSteepest.downstream_node_at_link
FlowDirectorSteepest.flow_link_direction
FlowDirectorSteepest.flow_link_direction_at_node
FlowDirectorSteepest.flow_link_incoming_at_node
FlowDirectorSteepest.run_one_step
FlowDirectorSteepest.updated_boundary_conditions
FlowDirectorSteepest.upstream_node_at_link
- FlowDirectorD8
- FlowDirectorMFD
- FlowDirectorDinf
- FlowDirectorSteepest
- DepressionFinderAndRouter: Handle depressions in terrain by calculating extent and drainage of “lakes”
DepressionFinderAndRouter
DepressionFinderAndRouter.__init__
DepressionFinderAndRouter.assign_outlet_receiver
DepressionFinderAndRouter.depression_depth
DepressionFinderAndRouter.depression_outlet_map
DepressionFinderAndRouter.display_depression_map
DepressionFinderAndRouter.find_depression_from_pit
DepressionFinderAndRouter.flood_status
DepressionFinderAndRouter.is_pit
DepressionFinderAndRouter.is_valid_outlet
DepressionFinderAndRouter.lake_areas
DepressionFinderAndRouter.lake_at_node
DepressionFinderAndRouter.lake_codes
DepressionFinderAndRouter.lake_map
DepressionFinderAndRouter.lake_outlets
DepressionFinderAndRouter.lake_volumes
DepressionFinderAndRouter.map_depressions
DepressionFinderAndRouter.node_can_drain
DepressionFinderAndRouter.number_of_lakes
DepressionFinderAndRouter.number_of_pits
DepressionFinderAndRouter.pit_node_ids
DepressionFinderAndRouter.receivers
DepressionFinderAndRouter.update
DepressionFinderAndRouter.updated_boundary_conditions
- FractureGridGenerator: Generate random fracture patterns on a regular raster grid
- gFlex: Compute elastic lithosphere flexure with variable rigidity
- GroundwaterDupuitPercolator: model flow in a shallow unconfined aquifer using the Dupuit-Forcheimer approximation
GroundwaterDupuitPercolator
GroundwaterDupuitPercolator.K
GroundwaterDupuitPercolator.__init__
GroundwaterDupuitPercolator.calc_gw_flux_at_node
GroundwaterDupuitPercolator.calc_gw_flux_out
GroundwaterDupuitPercolator.calc_recharge_flux_in
GroundwaterDupuitPercolator.calc_sw_flux_out
GroundwaterDupuitPercolator.calc_total_storage
GroundwaterDupuitPercolator.callback_fun
GroundwaterDupuitPercolator.courant_coefficient
GroundwaterDupuitPercolator.n
GroundwaterDupuitPercolator.number_of_substeps
GroundwaterDupuitPercolator.recharge
GroundwaterDupuitPercolator.run_one_step
GroundwaterDupuitPercolator.run_with_adaptive_time_step_solver
GroundwaterDupuitPercolator.vn_coefficient
get_link_hydraulic_conductivity
- HackCalculator: Calculate Hack’s law coefficients
- HeightAboveDrainageCalculator: Calculate height above nearest drainage
- LakeMapperBarnes: Component to temporarily fill depressions and reroute flow across them
LakeMapperBarnes
LakeMapperBarnes.__init__
LakeMapperBarnes.lake_areas
LakeMapperBarnes.lake_at_node
LakeMapperBarnes.lake_depths
LakeMapperBarnes.lake_dict
LakeMapperBarnes.lake_map
LakeMapperBarnes.lake_outlets
LakeMapperBarnes.lake_volumes
LakeMapperBarnes.number_of_lakes
LakeMapperBarnes.run_one_step
LakeMapperBarnes.update
LakeMapperBarnes.was_there_overfill
- Landslides: Compute probability of failure for shallow landslides
- landlab.components.lateral_erosion package
- Lithology: Create a 3D representation of variable lithology
Lithology
Lithology.__init__
Lithology.add_layer
Lithology.add_property
Lithology.add_rock_type
Lithology.dz
Lithology.dz_advection
Lithology.ids
Lithology.properties
Lithology.rock_cube_to_xarray
Lithology.rock_id
Lithology.run_one_step
Lithology.thickness
Lithology.tracked_properties
Lithology.update_rock_properties
Lithology.z_bottom
Lithology.z_top
- PerronNLDiffuse: Model soil creep using implicit solution to nonlinear diffusion law
- NormalFault: Vertical uplift of grid nodes based on a user-specified uplift time series
- OverlandFlow: Model shallow water flow over topography using the numerical approximation of de Almeida
- OverlandFlowBates: Model shallow water flow over topography using the numerical approximation of Bates
- KinematicWaveRengers
- KinwaveImplicitOverlandFlow
- KinwaveOverlandFlowModel
- LinearDiffusionOverlandFlowRouter
- PotentialEvapotranspiration: Compute potential evapotranspiration
- VegCA: Simulate plant competition with cellular automaton model for grass, shrubs, and trees
- PotentialityFlowRouter: Find flow directions and accumulation using potential-field theory
- Radiation: Calculate solar radiation on topography given latitude, date, and time
- SinkFiller: Permanently fill pits in a topography
- SoilMoisture: Compute the decay of soil moisture saturation at storm-interstorm time period
- Stream Power with Alluvium Conservation and Entrainment
- SpatialPrecipitationDistribution: Generate random sequence of spatially-resolved precipitation events
SpatialPrecipitationDistribution
SpatialPrecipitationDistribution.__init__
SpatialPrecipitationDistribution.calc_annual_rainfall
SpatialPrecipitationDistribution.coordinates_of_last_storm_center
SpatialPrecipitationDistribution.current_season
SpatialPrecipitationDistribution.current_year
SpatialPrecipitationDistribution.median_total_rainfall_last_season
SpatialPrecipitationDistribution.median_total_rainfall_last_year
SpatialPrecipitationDistribution.median_total_rainfall_this_season
SpatialPrecipitationDistribution.median_total_rainfall_this_year
SpatialPrecipitationDistribution.nodes_under_storm
SpatialPrecipitationDistribution.number_of_nodes_under_storm
SpatialPrecipitationDistribution.storm_area_last_storm
SpatialPrecipitationDistribution.storm_depth_last_storm
SpatialPrecipitationDistribution.storm_duration_last_storm
SpatialPrecipitationDistribution.storm_intensity_last_storm
SpatialPrecipitationDistribution.storm_recession_value_last_storm
SpatialPrecipitationDistribution.target_median_total_rainfall_this_season
SpatialPrecipitationDistribution.total_rainfall_last_season
SpatialPrecipitationDistribution.total_rainfall_last_year
SpatialPrecipitationDistribution.total_rainfall_this_season
SpatialPrecipitationDistribution.total_rainfall_this_year
SpatialPrecipitationDistribution.yield_seasons
SpatialPrecipitationDistribution.yield_storms
SpatialPrecipitationDistribution.yield_years
- Species Evolution
- SteepnessFinder: Calcuate steepness and concavity indices from gridded topography
- FastscapeEroder: Compute fluvial erosion using stream power theory (“fastscape” algorithm)
- StreamPower: Compute fluvial erosion using stream power theory (also uses “fastscape” algorithm but provides slightly different formulation and options)
- SedDepEroder: Compute fluvial erosion using using “tools and cover” theory
- StreamPowerSmoothThresholdEroder: Compute fluvial erosion using stream power theory with a numerically smoothed threshold
- TaylorNonLinearDiffuser: Model non-linear soil creep after Ganti et al. (2013)
- TransportLengthHillslopeDiffuser: Hillslope diffusion component in the style of Carretier et al. (2016), and Davy and Lague (2009)
- PrecipitationDistribution: Generate random sequence of precipitation events
PrecipitationDistribution
PrecipitationDistribution.__init__
PrecipitationDistribution.elapsed_time
PrecipitationDistribution.generate_from_stretched_exponential
PrecipitationDistribution.get_interstorm_event_duration
PrecipitationDistribution.get_precipitation_event_duration
PrecipitationDistribution.get_storm_depth
PrecipitationDistribution.get_storm_intensity
PrecipitationDistribution.get_storm_time_series
PrecipitationDistribution.intensity
PrecipitationDistribution.interstorm_duration
PrecipitationDistribution.seed_generator
PrecipitationDistribution.storm_depth
PrecipitationDistribution.storm_duration
PrecipitationDistribution.update
PrecipitationDistribution.yield_storm_interstorm_duration_intensity
PrecipitationDistribution.yield_storms
- Vegetation: Model plant dynamics using multiple representative plant species
- ExponentialWeatherer: exponential soil production function in the style of Ahnert (1976)
- ExponentialWeathererIntegrated: exponential soil production function in the style of Ahnert (1976) integrated in dt