Welcome to the PyDeltaRCM documentation

pyDeltaRCM is a computationally efficient, free and open source, and easy-to-customize numerical delta model based on the original DeltaRCM model design (Matlab DeltaRCM model by Man Liang). pyDeltaRCM delivers improved model stability and capabilities, infrastructure to support exploration with minimal boilerplate code, and establishes an approach to extending model capabilities that ensures reproducible and comparable studies.

(png, hires.png)

The weighted random walk of 20 water parcels in a pyDeltaRCM model run with default parameters.

Project information

• Installing
• Contributing
• License
• Code of Conduct

User documentation

• Getting Started
  • 10-minute tutorial
• User Guide
  • Running the model
  • Configuring an input YAML file
  • Starting model runs
  • Advanced model configurations
  • Working with subsidence
  • Model Output File
• Model Information
  • YAML Parameters
  • Time in pyDeltaRCM
  • Hydrodynamics
  • Morphodynamics
  • Model Output File
  • Available Model Hooks
• Examples of using and working with pyDeltaRCM
  • Running the model
  • Modifying initial conditions
  • Modifying boundary conditions
  • Modifying internal computations
  • Modifying Model Input/Output
  • Working with the Preprocessor

Developer documentation

• Developer Guide
  • Best Practices
    • Reproducibility
    • Model development
• API reference
  • model
    • The DeltaModel class and all attributes and methods
    • Model configuration reference
  • Preprocessor
    • Preprocessor classes and API
    • Preprocessor function and utilities
  • iteration_tools
    • Public API methods attached to model
  • init_tools
    • Public API methods attached to model
  • water_tools
    • Public API methods attached to model
    • water_tools helper functions
  • sed_tools
    • Public API methods attached to model
    • Router classes
    • sed_tools helper functions
  • shared_tools
    • Shared functions
    • Time scaling functions
    • Utilities
  • hook_tools
    • Public API methods attached to model
  • debug_tools
    • Public API methods attached to model
    • Public plotting methods
  • References
    • Search the Index