RavenPy

A Python wrapper to setup and run the hydrologic modelling framework Raven.
https://github.com/CSHS-CWRA/RavenPy

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

raven

Keywords from Contributors

hydrology archiving wps indices climate ogc xclim climate-science pavics birdhouse

Last synced: about 2 hours ago
JSON representation

Repository metadata

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

• Host: GitHub
• URL: https://github.com/CSHS-CWRA/RavenPy
• Owner: CSHS-CWRA
• License: mit
• Created: 2020-04-17T18:17:32.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2025-04-15T18:05:34.000Z (12 days ago)
• Last Synced: 2025-04-22T10:38:38.201Z (5 days ago)
• Topics: raven
• Language: Python
• Homepage: https://ravenpy.readthedocs.io
• Size: 13.2 MB
• Stars: 27
• Watchers: 3
• Forks: 5
• Open Issues: 16
• Releases: 38
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Authors: AUTHORS.rst
  • Zenodo: .zenodo.json

README.rst

          ==============
RavenPy |logo|
==============

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi| |versions|                                   |
+----------------------------+-----------------------------------------------------+
| Documentation and Support  | |docs|                                              |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |ossf-score|                              |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |black| |isort| |ruff| |pre-commit|                 |
+----------------------------+-----------------------------------------------------+
| Development Status         | |status| |build| |coveralls|                        |
+----------------------------+-----------------------------------------------------+


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

* Free software: MIT license
* Documentation: https://ravenpy.readthedocs.io

`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.

.. _CANARIE: https://www.canarie.ca
.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _Ouranos: https://www.ouranos.ca
.. _Ouranosinc/cookiecutter-pypackage: https://github.com/Ouranosinc/cookiecutter-pypackage
.. _Raven: https://raven.uwaterloo.ca
.. _docs: https://raven.uwaterloo.ca/files/v3.8/RavenManual_v3.8.pdf
.. _installation docs: https://ravenpy.readthedocs.io/en/latest/installation.html
.. _raven-hydro: https://github.com/Ouranosinc/raven-hydro


.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
        :target: https://github.com/psf/black
        :alt: Python Black

.. |build| image:: https://github.com/CSHS-CWRA/RavenPy/actions/workflows/main.yml/badge.svg
        :target: https://github.com/CSHS-CWRA/RavenPy/actions
        :alt: Build Status

.. |coveralls| image:: https://coveralls.io/repos/github/CSHS-CWRA/RavenPy/badge.svg
        :target: https://coveralls.io/github/CSHS-CWRA/RavenPy
        :alt: Coveralls

.. |docs| image:: https://readthedocs.org/projects/ravenpy/badge/?version=latest
        :target: https://ravenpy.readthedocs.io/en/latest
        :alt: Documentation Status

.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
        :target: https://pycqa.github.io/isort/
        :alt: Isort

.. |license| image:: https://img.shields.io/github/license/CSHS-CWRA/RavenPy.svg
        :target: https://github.com/CSHS-CWRA/RavenPy/blob/master/LICENSE
        :alt: License

.. |logo| image:: https://raw.githubusercontent.com/CSHS-CWRA/RavenPy/master/docs/_static/_images/logos/ravenpy-logo-small.png
        :target: https://github.com/CSHS-CWRA/RavenPy
        :alt: RavenPy Logo

..
    .. |ossf-bp| image:: https://bestpractices.coreinfrastructure.org/projects/9945/badge
            :target: https://bestpractices.coreinfrastructure.org/projects/9945
            :alt: Open Source Security Foundation Best Practices

.. |ossf-score| image:: https://api.securityscorecards.dev/projects/github.com/CSHS-CWRA/RavenPy/badge
        :target: https://securityscorecards.dev/viewer/?uri=github.com/CSHS-CWRA/RavenPy
        :alt: OpenSSF Scorecard

.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/CSHS-CWRA/RavenPy/master.svg
        :target: https://results.pre-commit.ci/latest/github/CSHS-CWRA/RavenPy/master
        :alt: pre-commit.ci status

.. |pypi| image:: https://img.shields.io/pypi/v/RavenPy.svg
        :target: https://pypi.python.org/pypi/RavenPy
        :alt: PyPI

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
        :target: https://github.com/astral-sh/ruff
        :alt: Ruff

.. |status| image:: https://www.repostatus.org/badges/latest/active.svg
        :target: https://www.repostatus.org/#active
        :alt: Project Status: Active - The project has reached a stable, usable state and is being actively developed.

.. |versions| image:: https://img.shields.io/pypi/pyversions/RavenPy.svg
        :target: https://pypi.python.org/pypi/RavenPy
        :alt: Supported Python Versions

        

---

Owner metadata

• Name: Canadian Society for Hydrological Sciences
• Login: CSHS-CWRA
• Email: [email protected]
• Kind: organization
• Description:
• Website: https://cwra.org/en/branches/affiliates/cshs-a
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/38532892?v=4
• Repositories: 3
• Last ynced at: 2023-02-28T03:31:02.223Z
• Profile URL: https://github.com/CSHS-CWRA

---

GitHub Events

Total

• Create event: 74
• Issues event: 14
• Release event: 5
• Watch event: 1
• Delete event: 65
• Member event: 1
• Issue comment event: 127
• Push event: 230
• Pull request review comment event: 23
• Pull request event: 142
• Pull request review event: 89

Last Year

• Create event: 74
• Issues event: 14
• Release event: 5
• Watch event: 1
• Delete event: 65
• Member event: 1
• Issue comment event: 127
• Push event: 230
• Pull request review comment event: 23
• Pull request event: 142
• Pull request review event: 89

---

Committers metadata

Last synced: 5 days ago

Name	Email	Commits
Zeitsperre	1****e	692
Christian Jauvin	c****n@g****m	375
David Huard	h****d@o****a	201
pre-commit-ci[bot]	6****]	90
dependabot[bot]	4****]	40
bumpversion[bot]	b****]@o****a	24
ets	r****t@e****a	23
Julie	j****i@u****a	21
lou-a	l****l@h****r	11
Long Vu	v****g@o****a	3
tlogan2000	l****s@o****a	3
CSHS Administrator	3****n	2
Pascal Bourgault	b****l@o****a	2
James Craig	3****e	1
MightyFranky	f****l@g****m	1
Aida Jabbari	a****1@u****a	1
TrellixVulnTeam	c****d@t****m	1

Committer domains:

• ouranos.ca: 5
• trellix.com: 1
• ulaval.ca: 1
• uwaterloo.ca: 1
• etsmtl.ca: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/CSHS-CWRA/RavenPy

---

---

---

Package metadata

• Total packages: 2
• Total downloads:
  • pypi: 1,512 last-month
• Total dependent packages: 1 (may contain duplicates)
• Total dependent repositories: 2 (may contain duplicates)
• Total versions: 62
• Total maintainers: 2

---

Dependencies

Score: 13.91890343909831