Welcome to RavenPy’s documentation!

Contents:

• RavenPy
  • Features
  • Install
  • Acknowledgements
• Installation
  • Anaconda Python Installation
  • Python Installation (pip)
  • Using A Custom Raven Model Binary
  • Customizing remote service datasets
  • Development Installation (from sources)
• Usage
  • Running Raven from existing configuration files
  • Exposing model outputs as Python objects
  • Configuring emulators
  • Running an emulator
• Model Configuration
  • The Config class
  • Gauge, StationForcing, GriddedForcing and ObservationData commands
  • Input validation
  • Accessing and modifying configuration options
  • Limitations
  • Raven emulators
  • Symbolic expressions in emulator configuration
• Model Execution
  • The Emulator class
• Reading Model Outputs
  • Accessing simulation results with OutputReader
  • Accessing results from multiple simulations using EnsembleReader
• Notebooks
  • Getting started - Tutorial
  • Advanced workflows
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
  • Tips
  • Translations
  • Code of Conduct
• Releasing
  • Deployment
  • Packaging
• Credits
  • Development Lead
  • Co-Developers
  • Contributors
• Changelog
  • Unreleased (latest)
  • v0.21.0 (2026-03-16)
  • v0.20.0 (2026-02-12)
  • v0.19.1 (2025-08-05)
  • v0.19.0 (2025-07-16)
  • v0.18.2 (2025-05-05)
  • v0.18.1 (2025-04-15)
  • v0.18.0 (2025-04-03)
  • v0.17.0 (2025-01-27)
  • v0.16.1 (2024-12-05)
  • v0.16.0 (2024-10-18)
  • v0.15.0 (2024-06-20)
  • v0.14.1 (2024-05-07)
  • v0.14.0 (2024-03-13)
  • v0.13.0 (2024-01-10)
  • v0.12.3 (2023-10-02)
  • v0.12.2 (2023-07-04)
  • v0.12.1 (2023-06-01)
  • v0.12.0 (2023-05-25)
  • v0.11.0 (2023-02-16)
  • v0.10.0 (2022-12-21)
  • v0.9.0 (2022-11-16)
  • v0.8.1 (2022-10-26)
  • v0.8.0 (2022-10-04)
  • v0.7.8 (2022-01-14)
  • 0.7.7 (2021-12-21)
  • 0.7.6 (2021-12-20)
  • v0.7.5 (2021-09-10)
  • v0.7.4 (2021-09-02)
  • v0.7.3 (2021-08-31)
  • v0.7.2 (2021-08-31)
  • v0.7.0 (2021-07-27)
  • v0.6.0 (2021-07-14)
  • v0.5.2 (2021-05-25)
  • v0.5.1 (2021-05-12)
  • v0.5.0 (2021-04-30)
  • v0.4.2 (2021-04-14)
  • v0.4.1 (2021-04-13)
  • v0.4.0 (2021-04-09)
  • v0.3.1 (2021-04-06)
  • v0.3.0 (2021-03-11)
  • v0.2.3 (2021-02-01)
  • v0.2.2 (2021-01-29)
  • v0.2.1 (2021-01-28)
  • v0.2.0 (2021-01-26)
  • v0.1.7 (2021-01-19)
  • v0.1.6 (2021-01-15)
  • v0.1.5 (2021-01-14)
  • v0.1.0 (2020-12-20)

Utility Scripts

• Utility Scripts
  • ravenpy generate-grid-weights
  • ravenpy aggregate-forcings-to-hrus
  • ravenpy collect-subbasins-upstream-of-gauge
  • ravenpy generate-hrus-from-routing-product

User API

• User API
  • Execution
  • Configuration
  • Emulators
  • Extractors
  • Utilities

All Modules

• ravenpy
  • ravenpy package

GitHub Repository

• CSHS-CWRA/RavenPy

Indices and tables

• Index

• Module Index

• Search Page