Skip to main content

A Python package to help run Raven, the hydrologic modelling framework.

Project description

PyPI Conda-Forge License Build status Documentation 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.12.1.tar.gz (7.2 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ravenpy-0.12.1.tar.gz
  • Upload date:
  • Size: 7.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for ravenpy-0.12.1.tar.gz
Algorithm Hash digest
SHA256 71b279d7d107655573eed125fdf29190bacc81a4def4660fc49a480555cc4e2b
MD5 cf9d317083c5c629b3924baa024cf273
BLAKE2b-256 1ff0a0292154821340c64118abfecfce66bcab2af72263932e0210634d202ace

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: ravenpy-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for ravenpy-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a7a8a7f5fb366391e62ad5187caee499cebb5d552fbea5860e4bf59e338e73e
MD5 171a7df0c0a935ec0212cb4f17f2383a
BLAKE2b-256 efa09018191c78abe2d27db5279b21b1e80b09b66cd3b8690781cccfc8d5ddc8

See more details on using hashes here.

Provenance

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