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
- Concentration Tracker
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
ChiFinderChiFinder.__init__ChiFinder.best_fit_chi_elevation_gradient_and_interceptChiFinder.calculate_chiChiFinder.chi_indicesChiFinder.create_chi_plotChiFinder.hillslope_maskChiFinder.integrate_chi_avg_dxChiFinder.integrate_chi_each_dxChiFinder.masked_chi_indicesChiFinder.mean_channel_node_spacingChiFinder.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)
FlexureFlexure1DFlexure1D.__init__Flexure1D.alphaFlexure1D.calc_flexureFlexure1D.dz_at_nodeFlexure1D.eetFlexure1D.gamma_mantleFlexure1D.gravityFlexure1D.load_at_nodeFlexure1D.methodFlexure1D.rho_mantleFlexure1D.rho_waterFlexure1D.rigidityFlexure1D.run_one_stepFlexure1D.subside_loadsFlexure1D.updateFlexure1D.x_at_nodeFlexure1D.youngs
get_flexure_parametersubside_point_load
- Functions used to calculate lithospheric deflection
- FlowAccumulator: Component to do FlowAccumulation with the FlowDirectors
FlowAccumulatorFlowAccumulator.__init__FlowAccumulator.accumulate_flowFlowAccumulator.depression_finderFlowAccumulator.depression_handler_raster_direction_methodFlowAccumulator.flooded_nodes_presentFlowAccumulator.flow_directorFlowAccumulator.flow_director_raster_methodFlowAccumulator.headwater_nodesFlowAccumulator.link_order_upstreamFlowAccumulator.node_drainage_areaFlowAccumulator.node_order_upstreamFlowAccumulator.node_water_dischargeFlowAccumulator.pits_presentFlowAccumulator.run_one_stepFlowAccumulator.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
FlowDirectorSteepestFlowDirectorSteepest.__init__FlowDirectorSteepest.direct_flowFlowDirectorSteepest.downstream_node_at_linkFlowDirectorSteepest.flow_link_directionFlowDirectorSteepest.flow_link_direction_at_nodeFlowDirectorSteepest.flow_link_incoming_at_nodeFlowDirectorSteepest.run_one_stepFlowDirectorSteepest.updated_boundary_conditionsFlowDirectorSteepest.upstream_node_at_link
- FlowDirectorD8
- FlowDirectorMFD
- FlowDirectorDinf
- FlowDirectorSteepest
- DepressionFinderAndRouter: Handle depressions in terrain by calculating extent and drainage of “lakes”
DepressionFinderAndRouterDepressionFinderAndRouter.__init__DepressionFinderAndRouter.assign_outlet_receiverDepressionFinderAndRouter.depression_depthDepressionFinderAndRouter.depression_outlet_mapDepressionFinderAndRouter.display_depression_mapDepressionFinderAndRouter.find_depression_from_pitDepressionFinderAndRouter.flood_statusDepressionFinderAndRouter.is_pitDepressionFinderAndRouter.is_valid_outletDepressionFinderAndRouter.lake_areasDepressionFinderAndRouter.lake_at_nodeDepressionFinderAndRouter.lake_codesDepressionFinderAndRouter.lake_mapDepressionFinderAndRouter.lake_outletsDepressionFinderAndRouter.lake_volumesDepressionFinderAndRouter.map_depressionsDepressionFinderAndRouter.node_can_drainDepressionFinderAndRouter.number_of_lakesDepressionFinderAndRouter.number_of_pitsDepressionFinderAndRouter.pit_node_idsDepressionFinderAndRouter.receiversDepressionFinderAndRouter.updateDepressionFinderAndRouter.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
GroundwaterDupuitPercolatorGroundwaterDupuitPercolator.KGroundwaterDupuitPercolator.__init__GroundwaterDupuitPercolator.calc_gw_flux_at_nodeGroundwaterDupuitPercolator.calc_gw_flux_outGroundwaterDupuitPercolator.calc_recharge_flux_inGroundwaterDupuitPercolator.calc_sw_flux_outGroundwaterDupuitPercolator.calc_total_storageGroundwaterDupuitPercolator.callback_funGroundwaterDupuitPercolator.courant_coefficientGroundwaterDupuitPercolator.nGroundwaterDupuitPercolator.number_of_substepsGroundwaterDupuitPercolator.rechargeGroundwaterDupuitPercolator.run_one_stepGroundwaterDupuitPercolator.run_with_adaptive_time_step_solverGroundwaterDupuitPercolator.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
LakeMapperBarnesLakeMapperBarnes.__init__LakeMapperBarnes.lake_areasLakeMapperBarnes.lake_at_nodeLakeMapperBarnes.lake_depthsLakeMapperBarnes.lake_dictLakeMapperBarnes.lake_mapLakeMapperBarnes.lake_outletsLakeMapperBarnes.lake_volumesLakeMapperBarnes.number_of_lakesLakeMapperBarnes.run_one_stepLakeMapperBarnes.updateLakeMapperBarnes.was_there_overfill
- Landslides: Compute probability of failure for shallow landslides
- landlab.components.lateral_erosion package
- Lithology: Create a 3D representation of variable lithology
LithologyLithology.__init__Lithology.add_layerLithology.add_propertyLithology.add_rock_typeLithology.dzLithology.dz_advectionLithology.idsLithology.propertiesLithology.rock_cube_to_xarrayLithology.rock_idLithology.run_one_stepLithology.thicknessLithology.tracked_propertiesLithology.update_rock_propertiesLithology.z_bottomLithology.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
- Space: Stream Power with Alluvium Conservation and Entrainment
- SpaceLargeScaleEroder: SPACE large-scale eroder
SpaceLargeScaleEroderSpaceLargeScaleEroder.ErSpaceLargeScaleEroder.EsSpaceLargeScaleEroder.K_brSpaceLargeScaleEroder.K_sedSpaceLargeScaleEroder.__init__SpaceLargeScaleEroder.drainage_area_expSpaceLargeScaleEroder.fraction_finesSpaceLargeScaleEroder.run_one_stepSpaceLargeScaleEroder.run_one_step_basicSpaceLargeScaleEroder.sediment_influxSpaceLargeScaleEroder.sediment_porositySpaceLargeScaleEroder.settling_velocitySpaceLargeScaleEroder.slope_exp
- SpatialPrecipitationDistribution: Generate random sequence of spatially-resolved precipitation events
SpatialPrecipitationDistributionSpatialPrecipitationDistribution.__init__SpatialPrecipitationDistribution.calc_annual_rainfallSpatialPrecipitationDistribution.coordinates_of_last_storm_centerSpatialPrecipitationDistribution.current_seasonSpatialPrecipitationDistribution.current_yearSpatialPrecipitationDistribution.median_total_rainfall_last_seasonSpatialPrecipitationDistribution.median_total_rainfall_last_yearSpatialPrecipitationDistribution.median_total_rainfall_this_seasonSpatialPrecipitationDistribution.median_total_rainfall_this_yearSpatialPrecipitationDistribution.nodes_under_stormSpatialPrecipitationDistribution.number_of_nodes_under_stormSpatialPrecipitationDistribution.storm_area_last_stormSpatialPrecipitationDistribution.storm_depth_last_stormSpatialPrecipitationDistribution.storm_duration_last_stormSpatialPrecipitationDistribution.storm_intensity_last_stormSpatialPrecipitationDistribution.storm_recession_value_last_stormSpatialPrecipitationDistribution.target_median_total_rainfall_this_seasonSpatialPrecipitationDistribution.total_rainfall_last_seasonSpatialPrecipitationDistribution.total_rainfall_last_yearSpatialPrecipitationDistribution.total_rainfall_this_seasonSpatialPrecipitationDistribution.total_rainfall_this_yearSpatialPrecipitationDistribution.yield_seasonsSpatialPrecipitationDistribution.yield_stormsSpatialPrecipitationDistribution.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
PrecipitationDistributionPrecipitationDistribution.__init__PrecipitationDistribution.elapsed_timePrecipitationDistribution.generate_from_stretched_exponentialPrecipitationDistribution.get_interstorm_event_durationPrecipitationDistribution.get_precipitation_event_durationPrecipitationDistribution.get_storm_depthPrecipitationDistribution.get_storm_intensityPrecipitationDistribution.get_storm_time_seriesPrecipitationDistribution.intensityPrecipitationDistribution.interstorm_durationPrecipitationDistribution.seed_generatorPrecipitationDistribution.storm_depthPrecipitationDistribution.storm_durationPrecipitationDistribution.updatePrecipitationDistribution.yield_storm_interstorm_duration_intensityPrecipitationDistribution.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