Contents Menu Expand Light mode Dark mode Auto light/dark mode
Landlab 2.6 released!
landlab
Logo

Getting Started

  • Install
  • Tutorial notebooks
    • 10 minutes to Landlab
    • Self-study course for learning to use Landlab in your research
  • User Guide
    • Introduction to Python
    • Introduction to Landlab’s Gridding Library
    • The Component Library
    • What goes into a Landlab model?
    • How Landlab Is/Is Not Unit Agnostic
    • Tutorials
    • Teaching Tutorials
    • List of Components
    • List of Landlab Fields
    • List of Grid Methods
      • Nodes, Links, and Patches
      • Corners, Faces, and Cells
      • Boundary conditions
      • Subsets of elements
      • Mapping between elements
      • Gradients, fluxes, and divergences
      • Surface analysis
      • Fields
      • Uncategorized or Deprecated
    • Time steps
    • Examples
    • Frequently Asked Questions
    • Overland Flow Component User Manual
    • CellLab-CTS User Guide
    • Transition from Landlab 0.x to 1.0
    • Transition from Landlab 1.x to 2.0
    • Changes to standard names from Landlab 0.x to 1.x

Contributing

  • Developer Install
    • Virtual Environments
    • Updating and uninstalling
  • Developer Guide
    • Guidelines for Contributing Code to Landlab
      • Develop your own component or utility
        • Software Development Practices
          • Develop with Git
          • Continuous Integration Practices
          • Style Guidelines and Enforcement
          • Writing docstring and unit tests for your component (or utility)
          • How to create a Landlab release
          • How Landlab Specifies Dependencies
      • Recommendations and Rules for User-Contributed Components
      • Ongoing Development in Landlab
      • Desired Contributions to Landlab
      • Workflow to submit your Landlab contribution to Journal of Open Source Software
    • Software Development Practices
      • Develop with Git
      • Continuous Integration Practices
      • Style Guidelines and Enforcement
      • Writing docstring and unit tests for your component (or utility)
      • How to create a Landlab release
      • How Landlab Specifies Dependencies
    • Package Organization
  • API Reference
    • Basic Model Interface
    • Cellular Automata (CA)
      • landlab.ca.boundaries package
    • Command Interface
    • Components
      • 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
      • 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
      • 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
      • 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)
      • 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
      • GroundwaterDupuitPercolator: model flow in a shallow unconfined aquifer using the Dupuit-Forcheimer approximation
      • BedrockLandslider: Location and magnitude of episodic bedrock landsliding
      • Landslides: Compute probability of failure for shallow landslides
      • DimensionlessDischarge: Testing thresholds of debris flows in stream segments following Tang et al.
      • Vegetation: Model plant dynamics using multiple representative plant species
      • VegCA: Simulate plant competition with cellular automaton model for grass, shrubs, and trees
      • Species Evolution
      • PrecipitationDistribution: Generate random sequence of precipitation events
      • SpatialPrecipitationDistribution: Generate random sequence of spatially-resolved precipitation events
      • 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
      • CarbonateProducer: Grow carbonate strata using growth function of Bosscher and Schlager (1992)
      • SimpleSubmarineDiffuser: Calculate underwater sediment transport using water-depth-dependent diffusion
      • AdvectionSolverTVD: Model horizontal advection of a given quantity using a Total Variation Diminishing (TVD) solution method
      • 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
      • 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
      • FireGenerator: Generate random sequence of fire events
      • FractureGridGenerator: Generate random fracture patterns on a regular raster grid
      • Lithology: Create a 3D representation of variable lithology
      • LithoLayers: Create a layered lithology
      • ChannelProfiler: Create and plot channel profiles
      • ChiFinder: Perform chi-index analysis for gridded topography
      • 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)
      • Functions used to calculate lithospheric deflection
      • 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
      • The Landlab FlowDirectors: Components for Flow Direction
      • DepressionFinderAndRouter: Handle depressions in terrain by calculating extent and drainage of “lakes”
      • 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
      • HackCalculator: Calculate Hack’s law coefficients
      • HeightAboveDrainageCalculator: Calculate height above nearest drainage
      • LakeMapperBarnes: Component to temporarily fill depressions and reroute flow across them
      • Landslides: Compute probability of failure for shallow landslides
      • landlab.components.lateral_erosion package
      • Lithology: Create a 3D representation of variable lithology
      • 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
      • 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
      • 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
    • Core Landlab Classes
    • Data Record
    • Landlab Fields
    • Landlab Framework
    • Landlab Graph
      • landlab.graph.hex package
        • landlab.graph.hex.ext package
      • landlab.graph.matrix package
        • landlab.graph.matrix.ext package
      • landlab.graph.object package
        • landlab.graph.object.ext package
      • landlab.graph.quantity package
        • landlab.graph.quantity.ext package
      • landlab.graph.radial package
      • landlab.graph.sort package
        • landlab.graph.sort.ext package
      • landlab.graph.structured_quad package
        • landlab.graph.structured_quad.ext package
      • landlab.graph.voronoi package
        • landlab.graph.voronoi.ext package
      • landlab.graph.framed_voronoi package
      • landlab.graph.hex.ext package
      • landlab.graph.matrix.ext package
      • landlab.graph.object.ext package
      • landlab.graph.quantity.ext package
      • landlab.graph.sort.ext package
      • landlab.graph.structured_quad.ext package
      • landlab.graph.voronoi.ext package
    • Landlab Grids
      • API for landlab.grid.raster
      • API for landlab.grid.voronoi
      • API for landlab.grid.framed_voronoi
      • API for landlab.grid.hex
      • API for landlab.grid.radial
      • API for landlab.grid.network
      • API for landlab.grid.base
      • Grid creation from a formatted input file
      • Function/method decorators
      • landlab.grid.diagonals module
      • Divergence calculation functions
      • Gradient calculators
      • landlab.grid.grid_funcs module
      • landlab.grid.linkstatus module
      • Mapping data between different grid elements
      • landlab.grid.nodestatus module
      • Slope-aspect calculation functions
      • Miscellaneous raster-grid functions
      • Gradient calculation functions
      • Mapping data between different grid elements
      • Boundary handling for grid edges
      • landlab.grid.warnings module
      • API for landlab.grid.base
      • API for landlab.grid.raster
      • API for landlab.grid.voronoi
      • API for landlab.grid.framed_voronoi
      • API for landlab.grid.hex
      • API for landlab.grid.radial
      • API for landlab.grid.network
      • landlab.grid.unstructured package
    • Input/Output (IO)
      • Input and output of Landlab raster-grid data in ESRI Ascii Raster format
      • Input and output in native landlab format
      • Read and Write netCDF Files
      • Shapefiles
      • Output of Landlab raster- and hex-grid data in Wavefront OBJ format
      • Output of Landlab grid and field data in Legacy VTK format
    • Layers
      • EventLayers: Add event layers to a landlab grid
      • MaterialLayers: Add material layers to a landlab grid
    • Plotting and Visualization
    • Utilities and Decorators
      • landlab.utils.add_halo module
      • landlab.utils.count_repeats module
      • landlab.utils.decorators module
      • landlab.utils.depth_dependent_roughness module
      • landlab.utils.distance_to_divide module
      • landlab.utils.fault_facet_finder module
      • landlab.utils.flow__distance module
      • landlab.utils.jaggedarray module
      • landlab.utils.jaggedarray_ma module
      • landlab.utils.return_array module
      • landlab.utils.structured_grid module
      • landlab.utils.source_tracking_algorithm module
      • landlab.utils.stable_priority_queue module
      • landlab.utils.watershed module
      • landlab.utils.window_statistic module
      • Core Landlab Classes
    • Values
      • Synthetic field values
    • landlab

Useful Links

  • Release Notes
  • Contact
  • Citing Landlab
  • Funding
  • Contributors
  • License
  • Used by
  v: master
Versions
master
latest
release
mcflugen-clean-up-docs-requirements
Downloads
html
On Read the Docs
Project Home
Builds
Back to top
Edit this page

Getting Started#

  • 10 minutes to Landlab
  • Self-study course for learning to use Landlab in your research
Next
10 minutes to Landlab
Previous
Install
Copyright © 2023, The Landlab Team
Made with Sphinx and @pradyunsg's Furo
Powered by CSDMS