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

Getting Started

  • Install
  • Getting started
  • User Guide
    • Grid & Component reference
      • Landlab Grids
        • landlab.grid.base
        • landlab.grid.create
        • landlab.grid.decorators
        • landlab.grid.diagonals
        • landlab.grid.divergence
        • landlab.grid.gradients
        • landlab.grid.grid_funcs
        • landlab.grid.linkstatus
        • landlab.grid.mappers
        • landlab.grid.nodestatus
        • landlab.grid.raster_aspect
        • landlab.grid.raster_funcs
        • landlab.grid.raster_gradients
        • landlab.grid.raster_mappers
        • landlab.grid.raster_set_status
        • landlab.grid.warnings
        • landlab.grid.base
        • landlab.grid.raster
        • landlab.grid.voronoi
        • landlab.grid.framed_voronoi
        • landlab.grid.hex
        • landlab.grid.radial
        • landlab.grid.network
        • landlab.grid.icosphere
        • landlab.grid.unstructured
          • base
          • cells
          • links
          • nodes
          • status
      • Layers
        • landlab.layers
          • ext
          • eventlayers
          • materiallayers
      • landlab.components.lithology.lithology
      • landlab.components.lithology.litholayers
      • Values
        • landlab.values
          • synthetic
      • Components
        • landlab.components.diffusion
          • diffusion
        • landlab.components.nonlinear_diffusion
          • Perron_nl_diffuse
        • landlab.components.depth_dependent_diffusion
          • hillslope_depth_dependent_linear_flux
        • landlab.components.transport_length_diffusion
          • transport_length_hillslope_diffusion
        • landlab.components.taylor_nonlinear_hillslope_flux
          • taylor_nonlinear_hillslope_flux
        • landlab.components.depth_dependent_taylor_soil_creep
          • hillslope_depth_dependent_taylor_flux
        • landlab.components.threshold_eroder
          • threshold_eroder
        • landlab.components.concentration_tracker
          • concentration_tracker_for_diffusion
        • landlab.components.stream_power
          • fastscape_stream_power
          • sed_flux_dep_incision
          • stream_power
          • stream_power_smooth_threshold
        • landlab.components.detachment_ltd_erosion
          • generate_detachment_ltd_erosion
          • generate_erosion_by_depth_slope
        • landlab.components.erosion_deposition
          • erosion_deposition
          • generalized_erosion_deposition
          • shared_stream_power
        • landlab.components.space
          • space
          • space_large_scale_eroder
        • landlab.components.network_sediment_transporter
          • bed_parcel_initializers
          • network_sediment_transporter
          • sediment_pulser_at_links
          • sediment_pulser_base
          • sediment_pulser_each_parcel
        • landlab.components.gravel_river_transporter
          • gravel_river_transporter
        • landlab.components.area_slope_transporter
          • area_slope_transporter
        • landlab.components.gravel_bedrock_eroder
          • gravel_bedrock_eroder
        • landlab.components.flow_director
          • flow_direction_DN
          • flow_direction_dinf
          • flow_direction_mfd
          • flow_director
          • flow_director_d8
          • flow_director_dinf
          • flow_director_mfd
          • flow_director_steepest
          • flow_director_to_many
          • flow_director_to_one
        • landlab.components.flow_accum
          • flow_accum_bw
          • flow_accum_to_n
          • flow_accumulator
          • lossy_flow_accumulator
        • landlab.components.depression_finder
          • floodstatus
          • lake_mapper
        • landlab.components.lake_fill
          • lake_fill_barnes
        • landlab.components.priority_flood_flow_router
          • priority_flood_flow_router
        • landlab.components.sink_fill
          • fill_sinks
          • sink_fill_barnes
        • landlab.components.overland_flow
          • generate_overland_flow_Bates
          • generate_overland_flow_deAlmeida
          • generate_overland_flow_implicit_kinwave
          • generate_overland_flow_kinwave
          • kinematic_wave_rengers
          • linear_diffusion_overland_flow_router
        • landlab.components.tidal_flow
          • tidal_flow_calculator
        • landlab.components.radiation
          • radiation
        • landlab.components.pet
          • potential_evapotranspiration_field
        • landlab.components.soil_moisture
          • infiltrate_soil_green_ampt
          • soil_moisture_dynamics
        • landlab.components.groundwater
          • dupuit_percolator
        • landlab.components.bedrock_landslider
          • bedrock_landslider
        • landlab.components.landslides
          • landslide_probability
        • landlab.components.dimensionless_discharge
          • dimensionless_discharge
        • landlab.components.vegetation_dynamics
          • vegetation_dynamics
        • landlab.components.plant_competition_ca
          • plant_competition_ca
        • landlab.components.species_evolution
          • base_taxon
          • record
          • species_evolver
          • zone
          • zone_controller
          • zone_taxon
        • landlab.components.uniform_precip
          • generate_uniform_precip
        • landlab.components.spatial_precip
          • generate_spatial_precip
        • landlab.components.weathering
          • exponential_weathering
          • exponential_weathering_integrated
        • landlab.components.carbonate
          • carbonate_producer
        • landlab.components.marine_sediment_transport
          • simple_submarine_diffuser
        • landlab.components.advection
          • advection_solver_tvd
          • flux_limiters
        • landlab.components.steepness_index
          • channel_steepness
        • landlab.components.chi_index
          • channel_chi
        • landlab.components.drainage_density
          • drainage_density
        • landlab.components.profiler.channel_profiler
        • landlab.components.profiler.trickle_down_profiler
        • landlab.components.hack_calculator
          • hack_calculator
        • landlab.components.hand_calculator
          • hand_calculator
        • landlab.components.flexure
          • flexure
          • flexure_1d
          • funcs
        • landlab.components.gflex
          • flexure
        • landlab.components.normal_fault
          • normal_fault
        • landlab.components.tectonics
          • listric_kinematic_extender
        • landlab.components.fire_generator
          • generate_fire
        • landlab.components.fracture_grid
          • fracture_grid
    • 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
    • Introduction to Landlab’s Gridding Library
    • The Component Library
    • What goes into a Landlab model?
    • How Landlab Is/Is Not Unit Agnostic
    • Time steps
    • Frequently Asked Questions
    • Overland Flow Component User Manual
    • CellLab-CTS User Guide
  • Tutorials
    • Gallery
      • TVD advection solver and related functions
      • Agent-based modeling with Landlab and Mesa
      • Coupling a Landlab groundwater with a Mesa agent-based model
      • Wolf-Sheep-Grass Model with Soil Creep
      • Setting Boundary Conditions: interior rectangle
      • Setting Boundary Conditions on the Perimeter of a Raster.
      • Setting Boundary Conditions on a Voronoi.
      • Setting watershed boundary conditions on a raster grid
      • The Carbonate Producer component
      • Getting to know the Landlab component library
      • DataRecord Tutorial
      • Tutorial For Cellular Automaton Vegetation Model Coupled With Ecohydrologic Model
      • Tutorial For Cellular Automaton Vegetation Model Coupled With Ecohydrologic Model
      • Introduction to Landlab: Creating a simple 2D scarp diffusion model
      • Understanding and working with Landlab data fields
      • Using the Landlab 1D flexure component
      • Using the Landlab flexure component
      • Landscape evolution model with Priority flood and Space_v2
      • Introduction to priority flood component
      • Comparison of FlowDirectors
      • Introduction to the FlowAccumulator
      • Introduction to FlowDirectors
      • Introduction to PriorityFloodFlowRouter (priorityFlood filler, director and accumulator)
      • Using the Landlab FractureGridGenerator component
      • Using Landlab’s gradient and flux divergence functions
      • Diverse grid classes
      • What happens when you create a grid object?
      • How to create and visualize a Landlab Icosphere Grid
      • Icosphere example models
      • Modeling groundwater flow in a conceptual catchment
      • Component Overview: DepthDependentTaylorDiffuser
      • Component Overview: TaylorNonLinearDiffuser
      • The transport-length hillslope diffuser
      • The Basics
      • Example 1:
      • Example 2:
      • Unit tests and parameterization for AreaSlopeTransporter
      • Example of a transport-limited LEM using AreaSlopeTransporter
      • Introduction to the ErosionDeposition component
      • Using the Landlab Shared Stream Power Model
      • Run with Transient Uplift
      • Unit Tests for the Landlab GravelBedrockEroder Component
      • The Landlab GravelRiverTransporter Component
      • HyLands: modelling the evolution of landscapes and mass movements
      • Adding a discharge point source to a LEM
      • The StreamPowerSmoothThresholdEroder component
      • User guide and example for the Landlab SPACE_large_Scale_eroder component
      • User guide and example for the Landlab SPACE component
      • User guide and example for the Landlab threshold_eroder component
      • Introduction to the Lithology and LithoLayers objects
      • Tips on Writing Landlab Components
      • How to write a Landlab component
      • Mapping values between grid elements
      • Using the Landlab SimpleSubmarineDiffuser component
      • Landslide Runout Animation
      • Synthetic landscape animation
      • Building a matrix for numerical methods using a Landlab grid
      • Using the Landlab BedParcelInitializer components to initialize river bed sediment parcels for the NetworkSedimentTransporter component
      • Create A Network Grid from Raster Grid
      • Using plotting tools associated with the Landlab NetworkSedimentTransporter component
      • Using the Landlab NetworkSedimentTransporter component
      • Using USGS NHDPlus HR Datasets With the Landlab NetworkSedimentTransporter Component
      • Using the Landlab NetworkSedimentTransporter component starting with a shapefile river network
      • Profiling and Scaling Analysis of the NetworkSedimentTransporter
      • Generate a Network Model Grid on an OpenTopography DEM
      • Using SedimentPulserAtLinks to add sediment parcels to a channel network
      • Using SedimentPulserEachParcel to add sediment parcels to a channel network
      • Introduction to the NormalFault component
      • Writing with legacy vtk files
      • A coupled rainfall-runoff model in Landlab
      • How to do “D4” pit-filling on a digital elevation model (DEM)
      • The deAlmeida Overland Flow Component
      • The Implicit Kinematic Wave Overland Flow Component
      • The Linear Diffusion Overland Flow Router
      • Components for modeling overland flow erosion
      • Green-Ampt infiltration and kinematic wave overland flow
      • Animate Landlab output
      • Plotting grid data with Landlab
      • A super-brief intro to Python and NumPy
      • How to read a DEM as a Landlab grid
      • Introduction to the SpeciesEvolver component
      • Using the Landlab ListricKinematicExtender component
      • Using the ChiFinder Component
      • Using the DrainageDensity Component
      • Application of the flow__distance utility on a Sicilian basin
      • Using the HackCalculator Component
      • Using the SteepnessFinder Component
      • Tidal Flow Calculator
      • Importing Landlab .obj format output into Blender
      • Viewing Landlab output in ParaView
  • Teaching with Landlab
    • Getting started
    • Gallery
      • Quantifying river channel evolution with Landlab
      • Modeling Hillslopes and Channels with Landlab
      • Linear diffusion exercise with Landlab
      • Using Landlab to explore a diffusive hillslope in the piedmont of North Carolina
      • Exploring rainfall driven hydrographs with Landlab

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
    • bmi
      • bmi_bridge
      • components
      • standard_names
    • ca
      • boundaries
        • hex_lattice_tectonicizer
      • celllab_cts
      • hex_cts
      • oriented_hex_cts
      • oriented_raster_cts
      • raster_cts
    • cmd
      • authors
      • landlab
    • components
      • advection
        • advection_solver_tvd
        • flux_limiters
      • area_slope_transporter
        • area_slope_transporter
      • bedrock_landslider
        • bedrock_landslider
      • carbonate
        • carbonate_producer
      • chi_index
        • channel_chi
      • concentration_tracker
        • concentration_tracker_for_diffusion
      • depression_finder
        • floodstatus
        • lake_mapper
      • depth_dependent_diffusion
        • hillslope_depth_dependent_linear_flux
      • depth_dependent_taylor_soil_creep
        • hillslope_depth_dependent_taylor_flux
      • detachment_ltd_erosion
        • generate_detachment_ltd_erosion
        • generate_erosion_by_depth_slope
      • diffusion
        • diffusion
      • dimensionless_discharge
        • dimensionless_discharge
      • discharge_diffuser
        • diffuse_by_discharge
      • drainage_density
        • drainage_density
      • erosion_deposition
        • erosion_deposition
        • generalized_erosion_deposition
        • shared_stream_power
      • fire_generator
        • generate_fire
      • flexure
        • flexure
        • flexure_1d
        • funcs
      • flow_accum
        • flow_accum_bw
        • flow_accum_to_n
        • flow_accumulator
        • lossy_flow_accumulator
      • flow_director
        • flow_direction_DN
        • flow_direction_dinf
        • flow_direction_mfd
        • flow_director
        • flow_director_d8
        • flow_director_dinf
        • flow_director_mfd
        • flow_director_steepest
        • flow_director_to_many
        • flow_director_to_one
      • flow_router
        • ext
          • single_flow
            • priority_routing
      • fracture_grid
        • fracture_grid
      • gflex
        • flexure
      • gravel_bedrock_eroder
        • gravel_bedrock_eroder
      • gravel_river_transporter
        • gravel_river_transporter
      • groundwater
        • dupuit_percolator
      • hack_calculator
        • hack_calculator
      • hand_calculator
        • hand_calculator
      • lake_fill
        • lake_fill_barnes
      • landslides
        • landslide_probability
      • lateral_erosion
        • lateral_erosion
        • node_finder
      • lithology
        • litholayers
        • lithology
      • marine_sediment_transport
        • simple_submarine_diffuser
      • mass_wasting_runout
        • mass_wasting_runout
        • mass_wasting_saver
      • network_sediment_transporter
        • bed_parcel_initializers
        • network_sediment_transporter
        • sediment_pulser_at_links
        • sediment_pulser_base
        • sediment_pulser_each_parcel
      • nonlinear_diffusion
        • Perron_nl_diffuse
      • normal_fault
        • normal_fault
      • overland_flow
        • generate_overland_flow_Bates
        • generate_overland_flow_deAlmeida
        • generate_overland_flow_implicit_kinwave
        • generate_overland_flow_kinwave
        • kinematic_wave_rengers
        • linear_diffusion_overland_flow_router
      • pet
        • potential_evapotranspiration_field
      • plant_competition_ca
        • plant_competition_ca
      • potentiality_flowrouting
        • route_flow_by_boundary
      • priority_flood_flow_router
        • priority_flood_flow_router
      • profiler
        • base_profiler
        • channel_profiler
        • profiler
        • trickle_down_profiler
      • radiation
        • radiation
      • sink_fill
        • fill_sinks
        • sink_fill_barnes
      • soil_moisture
        • infiltrate_soil_green_ampt
        • soil_moisture_dynamics
      • space
        • space
        • space_large_scale_eroder
      • spatial_precip
        • generate_spatial_precip
      • species_evolution
        • base_taxon
        • record
        • species_evolver
        • zone
        • zone_controller
        • zone_taxon
      • steepness_index
        • channel_steepness
      • stream_power
        • fastscape_stream_power
        • sed_flux_dep_incision
        • stream_power
        • stream_power_smooth_threshold
      • taylor_nonlinear_hillslope_flux
        • taylor_nonlinear_hillslope_flux
      • tectonics
        • listric_kinematic_extender
      • threshold_eroder
        • threshold_eroder
      • tidal_flow
        • tidal_flow_calculator
      • transport_length_diffusion
        • transport_length_hillslope_diffusion
      • uniform_precip
        • generate_uniform_precip
      • vegetation_dynamics
        • vegetation_dynamics
      • weathering
        • exponential_weathering
        • exponential_weathering_integrated
    • core
      • errors
      • messages
      • model_component
      • model_parameter_loader
      • utils
    • data_record
      • aggregators
      • data_record
    • field
      • errors
      • graph_field
    • framework
      • component
      • decorators
      • interfaces
    • graph
      • ext
      • framed_voronoi
        • dual_framed_voronoi
        • framed_voronoi
      • hex
        • ext
        • dual_hex
        • hex
      • matrix
        • ext
        • at_node
        • at_patch
      • object
        • ext
        • at_node
        • at_patch
      • quantity
        • ext
        • of_link
        • of_patch
      • quasi_spherical
        • dual_icosphere
        • refinable_icosahedron
      • radial
        • dual_radial
        • radial
      • sort
        • ext
        • intpair
        • sort
      • structured_quad
        • ext
        • dual_structured_quad
        • structured_quad
      • voronoi
        • ext
        • dual_voronoi
        • voronoi
        • voronoi_to_graph
      • dual
      • graph
      • graph_convention
      • ugrid
    • grid
      • unstructured
        • base
        • cells
        • links
        • nodes
        • status
      • base
      • create
      • create_network
      • decorators
      • diagonals
      • divergence
      • framed_voronoi
      • gradients
      • grid_funcs
      • hex
      • hex_mappers
      • icosphere
      • linkorientation
      • linkstatus
      • mappers
      • network
      • nodestatus
      • radial
      • raster
      • raster_aspect
      • raster_divergence
      • raster_funcs
      • raster_gradients
      • raster_mappers
      • raster_set_status
      • voronoi
      • warnings
    • io
      • netcdf
        • dump
        • errors
        • load
        • read
        • write
      • esri_ascii
      • legacy_vtk
      • native_landlab
      • obj
      • shapefile
    • layers
      • ext
      • eventlayers
      • materiallayers
    • plot
      • network_sediment_transporter
        • locate_parcel_xy
        • plot_network_and_parcels
      • colors
      • drainage_plot
      • event_handler
      • graph
      • imshow
      • imshowhs
      • layers
      • video_out
    • utils
      • ext
      • add_halo
      • count_repeats
      • decorators
      • depth_dependent_roughness
      • distance_to_divide
      • fault_facet_finder
      • flow__distance
      • jaggedarray
      • jaggedarray_ma
      • matrix
      • return_array
      • source_tracking_algorithm
      • stable_priority_queue
      • structured_grid
      • suppress_output
      • watershed
      • window_statistic
    • values
      • synthetic

About

  • Release Notes
  • Contact
  • Citing Landlab
  • Funding
  • Contributors
  • License
  • Used by

Project Links

  • GitHub
  • PyPI
  • Conda-Forge
Back to top
Edit this page

landlab.framework#

The Landlab modeling framework.

Submodules#

  • component
    • iscomponent
    • load_components
    • load_components_from_dir
    • load_landlab_components
  • decorators
    • camel_case
    • snake_case
  • interfaces
    • BadVarNameError
    • BmiBase
    • BmiExtendedBase
    • BmiGridType
    • BmiNoGrid
    • BmiRectilinear
    • BmiStructured
    • BmiUniformRectilinear
    • BmiUnstructured
    • Error
    • FatalError
    • MissingModelAttributeError
    • TimeBoundsError
Next
landlab.framework.component
Previous
landlab.field.graph_field
Copyright © 2024, The Landlab Team
Made with Sphinx and @pradyunsg's Furo
Powered by CSDMS
On this page
  • landlab.framework
    • Submodules