Hide navigation sidebar

Hide table of contents sidebar

Landlab 2.9 released!

Toggle site navigation sidebar

Toggle table of contents sidebar

Getting Started

Install
Getting started
User Guide
Toggle navigation of User Guide
- Grid & Component reference
  Toggle navigation of Grid & Component reference
  - Landlab Grids
    Toggle navigation of 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
      Toggle navigation of landlab.grid.unstructured
      - base
      - cells
      - links
      - nodes
      - status
  - Layers
    Toggle navigation of Layers
    - landlab.layers
      Toggle navigation of landlab.layers
  - landlab.components.lithology.lithology
  - landlab.components.lithology.litholayers
  - Values
    Toggle navigation of Values
    - landlab.values
      Toggle navigation of landlab.values
      - synthetic
  - Components
    Toggle navigation of Components
    - landlab.components.diffusion
      Toggle navigation of landlab.components.diffusion
      - diffusion
    - landlab.components.nonlinear_diffusion
      Toggle navigation of landlab.components.nonlinear_diffusion
      - Perron_nl_diffuse
    - landlab.components.depth_dependent_diffusion
      Toggle navigation of landlab.components.depth_dependent_diffusion
      - hillslope_depth_dependent_linear_flux
    - landlab.components.transport_length_diffusion
      Toggle navigation of landlab.components.transport_length_diffusion
      - transport_length_hillslope_diffusion
    - landlab.components.taylor_nonlinear_hillslope_flux
      Toggle navigation of landlab.components.taylor_nonlinear_hillslope_flux
      - taylor_nonlinear_hillslope_flux
    - landlab.components.depth_dependent_taylor_soil_creep
      Toggle navigation of landlab.components.depth_dependent_taylor_soil_creep
      - hillslope_depth_dependent_taylor_flux
    - landlab.components.threshold_eroder
      Toggle navigation of landlab.components.threshold_eroder
      - threshold_eroder
    - landlab.components.concentration_tracker
      Toggle navigation of landlab.components.concentration_tracker
      - concentration_tracker_for_diffusion
    - landlab.components.stream_power
      Toggle navigation of landlab.components.stream_power
    - landlab.components.detachment_ltd_erosion
      Toggle navigation of landlab.components.detachment_ltd_erosion
      - generate_detachment_ltd_erosion
      - generate_erosion_by_depth_slope
    - landlab.components.erosion_deposition
      Toggle navigation of landlab.components.erosion_deposition
    - landlab.components.space
      Toggle navigation of landlab.components.space
      - space
      - space_large_scale_eroder
    - landlab.components.network_sediment_transporter
      Toggle navigation of landlab.components.network_sediment_transporter
    - landlab.components.gravel_river_transporter
      Toggle navigation of landlab.components.gravel_river_transporter
      - gravel_river_transporter
    - landlab.components.area_slope_transporter
      Toggle navigation of landlab.components.area_slope_transporter
      - area_slope_transporter
    - landlab.components.gravel_bedrock_eroder
      Toggle navigation of landlab.components.gravel_bedrock_eroder
      - gravel_bedrock_eroder
    - landlab.components.flow_director
      Toggle navigation of landlab.components.flow_director
    - landlab.components.flow_accum
      Toggle navigation of landlab.components.flow_accum
    - landlab.components.depression_finder
      Toggle navigation of landlab.components.depression_finder
      - floodstatus
      - lake_mapper
    - landlab.components.lake_fill
      Toggle navigation of landlab.components.lake_fill
      - lake_fill_barnes
    - landlab.components.priority_flood_flow_router
      Toggle navigation of landlab.components.priority_flood_flow_router
      - priority_flood_flow_router
    - landlab.components.sink_fill
      Toggle navigation of landlab.components.sink_fill
      - fill_sinks
      - sink_fill_barnes
    - landlab.components.overland_flow
      Toggle navigation of landlab.components.overland_flow
    - landlab.components.tidal_flow
      Toggle navigation of landlab.components.tidal_flow
      - tidal_flow_calculator
    - landlab.components.radiation
      Toggle navigation of landlab.components.radiation
      - radiation
    - landlab.components.pet
      Toggle navigation of landlab.components.pet
      - potential_evapotranspiration_field
    - landlab.components.soil_moisture
      Toggle navigation of landlab.components.soil_moisture
      - infiltrate_soil_green_ampt
      - soil_moisture_dynamics
    - landlab.components.groundwater
      Toggle navigation of landlab.components.groundwater
      - dupuit_percolator
    - landlab.components.bedrock_landslider
      Toggle navigation of landlab.components.bedrock_landslider
      - bedrock_landslider
    - landlab.components.landslides
      Toggle navigation of landlab.components.landslides
      - landslide_probability
    - landlab.components.dimensionless_discharge
      Toggle navigation of landlab.components.dimensionless_discharge
      - dimensionless_discharge
    - landlab.components.vegetation_dynamics
      Toggle navigation of landlab.components.vegetation_dynamics
      - vegetation_dynamics
    - landlab.components.plant_competition_ca
      Toggle navigation of landlab.components.plant_competition_ca
      - plant_competition_ca
    - landlab.components.species_evolution
      Toggle navigation of landlab.components.species_evolution
    - landlab.components.uniform_precip
      Toggle navigation of landlab.components.uniform_precip
      - generate_uniform_precip
    - landlab.components.spatial_precip
      Toggle navigation of landlab.components.spatial_precip
      - generate_spatial_precip
    - landlab.components.weathering
      Toggle navigation of landlab.components.weathering
      - exponential_weathering
      - exponential_weathering_integrated
    - landlab.components.carbonate
      Toggle navigation of landlab.components.carbonate
      - carbonate_producer
    - landlab.components.marine_sediment_transport
      Toggle navigation of landlab.components.marine_sediment_transport
      - simple_submarine_diffuser
    - landlab.components.advection
      Toggle navigation of landlab.components.advection
      - advection_solver_tvd
      - flux_limiters
    - landlab.components.steepness_index
      Toggle navigation of landlab.components.steepness_index
      - channel_steepness
    - landlab.components.chi_index
      Toggle navigation of landlab.components.chi_index
      - channel_chi
    - landlab.components.drainage_density
      Toggle navigation of landlab.components.drainage_density
      - drainage_density
    - landlab.components.profiler.channel_profiler
    - landlab.components.profiler.trickle_down_profiler
    - landlab.components.hack_calculator
      Toggle navigation of landlab.components.hack_calculator
      - hack_calculator
    - landlab.components.hand_calculator
      Toggle navigation of landlab.components.hand_calculator
      - hand_calculator
    - landlab.components.flexure
      Toggle navigation of landlab.components.flexure
      - flexure
      - flexure_1d
      - funcs
    - landlab.components.gflex
      Toggle navigation of landlab.components.gflex
      - flexure
    - landlab.components.normal_fault
      Toggle navigation of landlab.components.normal_fault
      - normal_fault
    - landlab.components.tectonics
      Toggle navigation of landlab.components.tectonics
      - listric_kinematic_extender
    - landlab.components.fire_generator
      Toggle navigation of landlab.components.fire_generator
      - generate_fire
    - landlab.components.fracture_grid
      Toggle navigation of landlab.components.fracture_grid
      - fracture_grid
- List of Components
- List of Landlab Fields
- List of Grid Methods
  Toggle navigation of List of Grid Methods
- 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
Toggle navigation of Tutorials
- Gallery
  Toggle navigation of Gallery
Teaching with Landlab
Toggle navigation of Teaching with Landlab
- Getting started
- Gallery
  Toggle navigation of Gallery

Contributing

Developer Install
Toggle navigation of Developer Install
- Virtual Environments
- Updating and uninstalling
Developer Guide
Toggle navigation of Developer Guide
- Guidelines for Contributing Code to Landlab
  Toggle navigation of Guidelines for Contributing Code to Landlab
  - Develop your own component or utility
    Toggle navigation of Develop your own component or utility
    - Software Development Practices
      Toggle navigation of Software Development Practices
  - 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
  Toggle navigation of Software Development Practices
- Package Organization
API Reference
Toggle navigation of API Reference
- bmi
  Toggle navigation of bmi
- ca
  Toggle navigation of ca
  - boundaries
    Toggle navigation of boundaries
    - hex_lattice_tectonicizer
  - celllab_cts
  - hex_cts
  - oriented_hex_cts
  - oriented_raster_cts
  - raster_cts
- cmd
  Toggle navigation of cmd
  - authors
  - landlab
- components
  Toggle navigation of components
  - advection
    Toggle navigation of advection
    - advection_solver_tvd
    - flux_limiters
  - area_slope_transporter
    Toggle navigation of area_slope_transporter
    - area_slope_transporter
  - bedrock_landslider
    Toggle navigation of bedrock_landslider
    - bedrock_landslider
  - carbonate
    Toggle navigation of carbonate
    - carbonate_producer
  - chi_index
    Toggle navigation of chi_index
    - channel_chi
  - concentration_tracker
    Toggle navigation of concentration_tracker
    - concentration_tracker_for_diffusion
  - depression_finder
    Toggle navigation of depression_finder
    - floodstatus
    - lake_mapper
  - depth_dependent_diffusion
    Toggle navigation of depth_dependent_diffusion
    - hillslope_depth_dependent_linear_flux
  - depth_dependent_taylor_soil_creep
    Toggle navigation of depth_dependent_taylor_soil_creep
    - hillslope_depth_dependent_taylor_flux
  - detachment_ltd_erosion
    Toggle navigation of detachment_ltd_erosion
    - generate_detachment_ltd_erosion
    - generate_erosion_by_depth_slope
  - diffusion
    Toggle navigation of diffusion
    - diffusion
  - dimensionless_discharge
    Toggle navigation of dimensionless_discharge
    - dimensionless_discharge
  - discharge_diffuser
    Toggle navigation of discharge_diffuser
    - diffuse_by_discharge
  - drainage_density
    Toggle navigation of drainage_density
    - drainage_density
  - erosion_deposition
    Toggle navigation of erosion_deposition
  - fire_generator
    Toggle navigation of fire_generator
    - generate_fire
  - flexure
    Toggle navigation of flexure
    - flexure
    - flexure_1d
    - funcs
  - flow_accum
    Toggle navigation of flow_accum
  - flow_director
    Toggle navigation of flow_director
  - flow_router
    Toggle navigation of flow_router
    - ext
      Toggle navigation of ext
      - single_flow
        Toggle navigation of single_flow
        
        priority_routing
  - fracture_grid
    Toggle navigation of fracture_grid
    - fracture_grid
  - gflex
    Toggle navigation of gflex
    - flexure
  - gravel_bedrock_eroder
    Toggle navigation of gravel_bedrock_eroder
    - gravel_bedrock_eroder
  - gravel_river_transporter
    Toggle navigation of gravel_river_transporter
    - gravel_river_transporter
  - groundwater
    Toggle navigation of groundwater
    - dupuit_percolator
  - hack_calculator
    Toggle navigation of hack_calculator
    - hack_calculator
  - hand_calculator
    Toggle navigation of hand_calculator
    - hand_calculator
  - lake_fill
    Toggle navigation of lake_fill
    - lake_fill_barnes
  - landslides
    Toggle navigation of landslides
    - landslide_probability
  - lateral_erosion
    Toggle navigation of lateral_erosion
    - lateral_erosion
    - node_finder
  - lithology
    Toggle navigation of lithology
    - litholayers
    - lithology
  - marine_sediment_transport
    Toggle navigation of marine_sediment_transport
    - simple_submarine_diffuser
  - mass_wasting_runout
    Toggle navigation of mass_wasting_runout
    - mass_wasting_runout
    - mass_wasting_saver
  - network_sediment_transporter
    Toggle navigation of network_sediment_transporter
  - nonlinear_diffusion
    Toggle navigation of nonlinear_diffusion
    - Perron_nl_diffuse
  - normal_fault
    Toggle navigation of normal_fault
    - normal_fault
  - overland_flow
    Toggle navigation of overland_flow
  - pet
    Toggle navigation of pet
    - potential_evapotranspiration_field
  - plant_competition_ca
    Toggle navigation of plant_competition_ca
    - plant_competition_ca
  - potentiality_flowrouting
    Toggle navigation of potentiality_flowrouting
    - route_flow_by_boundary
  - priority_flood_flow_router
    Toggle navigation of priority_flood_flow_router
    - priority_flood_flow_router
  - profiler
    Toggle navigation of profiler
  - radiation
    Toggle navigation of radiation
    - radiation
  - sink_fill
    Toggle navigation of sink_fill
    - fill_sinks
    - sink_fill_barnes
  - soil_moisture
    Toggle navigation of soil_moisture
    - infiltrate_soil_green_ampt
    - soil_moisture_dynamics
  - space
    Toggle navigation of space
    - space
    - space_large_scale_eroder
  - spatial_precip
    Toggle navigation of spatial_precip
    - generate_spatial_precip
  - species_evolution
    Toggle navigation of species_evolution
  - steepness_index
    Toggle navigation of steepness_index
    - channel_steepness
  - stream_power
    Toggle navigation of stream_power
  - taylor_nonlinear_hillslope_flux
    Toggle navigation of taylor_nonlinear_hillslope_flux
    - taylor_nonlinear_hillslope_flux
  - tectonics
    Toggle navigation of tectonics
    - listric_kinematic_extender
  - threshold_eroder
    Toggle navigation of threshold_eroder
    - threshold_eroder
  - tidal_flow
    Toggle navigation of tidal_flow
    - tidal_flow_calculator
  - transport_length_diffusion
    Toggle navigation of transport_length_diffusion
    - transport_length_hillslope_diffusion
  - uniform_precip
    Toggle navigation of uniform_precip
    - generate_uniform_precip
  - vegetation_dynamics
    Toggle navigation of vegetation_dynamics
    - vegetation_dynamics
  - weathering
    Toggle navigation of weathering
    - exponential_weathering
    - exponential_weathering_integrated
- core
  Toggle navigation of core
- data_record
  Toggle navigation of data_record
  - aggregators
  - data_record
- field
  Toggle navigation of field
  - errors
  - graph_field
- framework
  Toggle navigation of framework
- graph
  Toggle navigation of graph
  - ext
  - framed_voronoi
    Toggle navigation of framed_voronoi
    - dual_framed_voronoi
    - framed_voronoi
  - hex
    Toggle navigation of hex
    - ext
    - dual_hex
    - hex
  - matrix
    Toggle navigation of matrix
    - ext
    - at_node
    - at_patch
  - object
    Toggle navigation of object
    - ext
    - at_node
    - at_patch
  - quantity
    Toggle navigation of quantity
    - ext
    - of_link
    - of_patch
  - quasi_spherical
    Toggle navigation of quasi_spherical
    - dual_icosphere
    - refinable_icosahedron
  - radial
    Toggle navigation of radial
    - dual_radial
    - radial
  - sort
    Toggle navigation of sort
    - ext
    - intpair
    - sort
  - structured_quad
    Toggle navigation of structured_quad
  - voronoi
    Toggle navigation of voronoi
  - dual
  - graph
  - graph_convention
  - ugrid
- grid
  Toggle navigation of grid
  - unstructured
    Toggle navigation of 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
  Toggle navigation of io
  - netcdf
    Toggle navigation of netcdf
    - dump
    - errors
    - load
    - read
    - write
  - esri_ascii
  - legacy_vtk
  - native_landlab
  - obj
  - shapefile
- layers
  Toggle navigation of layers
- plot
  Toggle navigation of plot
  - network_sediment_transporter
    Toggle navigation of network_sediment_transporter
    - locate_parcel_xy
    - plot_network_and_parcels
  - colors
  - drainage_plot
  - event_handler
  - graph
  - imshow
  - imshowhs
  - layers
  - video_out
- utils
  Toggle navigation of utils
- values
  Toggle navigation of values
  - synthetic

About

Release Notes
Contact
Citing Landlab
Funding
Contributors
License
Used by

Project Links

GitHub
PyPI
Conda-Forge

Toggle table of contents sidebar

landlab.utils.ext#

landlab.utils.add_halo

Copyright © 2024, The Landlab Team

Made with Sphinx and @pradyunsg's Furo

Powered by CSDMS