Skip to main content

A Python wrapper to setup and run the hydrologic modelling framework Raven.

Project description

Versions

PyPI Supported Python Versions

Documentation and Support

Documentation Status

Open Source

License OpenSSF Scorecard

Coding Standards

Python Black Ruff pre-commit.ci status

Development Status

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Build Status Coveralls

A Python wrapper to setup and run the hydrologic modelling framework Raven.

RavenPy is a Python wrapper for Raven, accompanied by utility functions that facilitate model configuration, calibration, and evaluation.

Raven is an hydrological modeling framework that lets hydrologists build hydrological models by combining different hydrological processes together. It can also be used to emulate a variety of existing lumped and distributed models. Model structure, parameters, initial conditions and forcing files are configured in text files, which Raven parses to build and run hydrological simulations. A detailed description about modeling capability of Raven can be found in the docs.

RavenPy provides a Python interface to Raven, automating the creation of configuration files and allowing the model to be launched from Python. Results, or errors, are automatically parsed and exposed within the programming environment. This facilitates the launch of parallel simulations, multi-model prediction ensembles, sensitivity analyses and other experiments involving a large number of model runs.

Note that version 0.12 includes major changes compared to the previous 0.11 release, and breaks backward compatibility. The benefits of these changes are a much more intuitive interface for configuring and running the model.

Features

  • Configure, run and parse Raven outputs from Python

  • Utility command to create grid weight files

  • Extract physiographic information about watersheds

  • Algorithms to estimate model parameters from ungauged watersheds

  • Exposes outputs (flow, storage) as xarray.DataArray objects

Install

Please see the detailed installation docs.

Acknowledgements

RavenPy’s development has been funded by CANARIE and Ouranos and would be not be possible without the help of Juliane Mai and James Craig.

This package was created with Cookiecutter and the Ouranosinc/cookiecutter-pypackage project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ravenpy-0.16.0.tar.gz (8.2 MB view details)

Uploaded Source

Built Distribution

ravenpy-0.16.0-py3-none-any.whl (6.3 MB view details)

Uploaded Python 3

File details

Details for the file ravenpy-0.16.0.tar.gz.

File metadata

  • Download URL: ravenpy-0.16.0.tar.gz
  • Upload date:
  • Size: 8.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ravenpy-0.16.0.tar.gz
Algorithm Hash digest
SHA256 c095e4dda876a8718a0c255b80cc68cdf7e4e754c5cc2a6d8b534dcf27578b30
MD5 1e7a56c827649cec6b67cd77fce05e58
BLAKE2b-256 f17346b867b905d6fed9bac228dd7822a52365be0691af8231e305c292c918ae

See more details on using hashes here.

File details

Details for the file ravenpy-0.16.0-py3-none-any.whl.

File metadata

  • Download URL: ravenpy-0.16.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ravenpy-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 800b4df03a2582e60362aeb6a727c00f8c926e87ca13feae4e143547b2653980
MD5 ff5ddc38f4c2d11b09c7207ce49ce43e
BLAKE2b-256 d7db431f16621cd4979b879eee67a67f1a434e26123220ff85c0d3ac5fadc2ca

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page