xHydro

Effortlessly extract geospatial and watershed data from APIs, calibrate and execute hydrological models, perform optimal interpolation and frequency analysis on hydrological indicators, compute custom hydrological metrics, and analyze climate change impacts on hydrological data.
https://github.com/hydrologie/xhydro

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

hydrological-data-analysis hydrology hydrology-statistical

Keywords from Contributors

raven birdhouse pavics wps climate-analysis climate-science netcdf4 xclim anuclim icclim

Last synced: about 9 hours ago
JSON representation

Repository metadata

Hydrological analysis library built with xarray.

• Host: GitHub
• URL: https://github.com/hydrologie/xhydro
• Owner: hydrologie
• License: apache-2.0
• Created: 2023-05-05T13:54:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-07-06T20:46:34.000Z (about 2 months ago)
• Last Synced: 2026-08-05T13:17:51.678Z (29 days ago)
• Topics: hydrological-data-analysis, hydrology, hydrology-statistical
• Language: Python
• Homepage: https://xhydro.readthedocs.io
• Size: 47.6 MB
• Stars: 59
• Watchers: 4
• Forks: 7
• Open Issues: 16
• Releases: 15
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Security: SECURITY.md
  • Authors: AUTHORS.rst
  • Zenodo: .zenodo.json

README.rst

          ======================================
xHydro |logo| |logo-light| |logo-dark|
======================================

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

Hydrological analysis library built with xarray

* Free software: Apache-2.0
* Documentation: https://xhydro.readthedocs.io/en/latest/
* Version française: https://xhydro.readthedocs.io/fr/latest/

Features
--------

* Easily find and extract geospatial data from the Planetary Computer API and watershed boundaries from the HydroSHEDS API over any area of interest.
* Calibrate and execute Hydrotel and Raven-emulated hydrological models.
* Perform optimal interpolation on hydrological data (daily streamflow and indices).
* Compute hydrological indicators (e.g. n-day peak flow, annual maximum series, low flow, average flow, etc.) over custom date ranges.
* Perform frequency analyses on hydrological indicators using a variety of methods (e.g. Gumbel, GEV, etc.).
* Perform climate change impact analyses of hydrological data.

Credits
-------

This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pypackage`_ project template.

This logo was designed by Élyse Fournier (@elysefounier) and Louise Arnal (@lou-a), with inputs from the `xHydro` team.

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _`Ouranosinc/cookiecutter-pypackage`: https://github.com/Ouranosinc/cookiecutter-pypackage

.. |build| image:: https://github.com/hydrologie/xhydro/actions/workflows/main.yml/badge.svg
        :target: https://github.com/hydrologie/xhydro/actions
        :alt: Build Status

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/xhydro.svg
        :target: https://anaconda.org/conda-forge/xhydro
        :alt: Conda-forge Build Version

.. |coveralls| image:: https://coveralls.io/repos/github/hydrologie/xhydro/badge.svg
        :target: https://coveralls.io/github/hydrologie/xhydro
        :alt: Coveralls

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

.. |license| image:: https://img.shields.io/pypi/l/xhydro
        :target: https://github.com/hydrologie/xhydro/blob/main/LICENSE
        :alt: License

.. |logo| image:: https://raw.githubusercontent.com/hydrologie/xhydro/main/docs/logos/xhydro-logo-small-light.png
        :target: https://github.com/hydrologie/xhydro
        :alt: xHydro

.. |logo-light| image:: https://raw.githubusercontent.com/hydrologie/xhydro/main/docs/logos/empty.png
        :target: https://github.com/hydrologie/xhydro
        :alt:
        :class: xhydro-logo-small only-light-inline

.. |logo-dark| image:: https://raw.githubusercontent.com/hydrologie/xhydro/main/docs/logos/empty.png
        :target: https://github.com/hydrologie/xhydro
        :alt:
        :class: xhydro-logo-small only-dark-inline

..
    .. |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/hydrologie/xhydro/badge
        :target: https://securityscorecards.dev/viewer/?uri=github.com/hydrologie/xhydro
        :alt: OpenSSF Scorecard

.. |pre-commit-ci| image:: https://results.pre-commit.ci/badge/github/hydrologie/xHydro/main.svg
         :target: https://results.pre-commit.ci/latest/github/hydrologie/xHydro/main
         :alt: pre-commit.ci status

.. |prek| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
        :target: https://github.com/j178/prek
        :alt: prek

.. |pypi| image:: https://img.shields.io/pypi/v/xhydro.svg
        :target: https://pypi.python.org/pypi/xhydro
        :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/xhydro.svg
        :target: https://pypi.python.org/pypi/xhydro
        :alt: Supported Python Versions

        

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit and templated with cookiecutter.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: "1.2.0"
title: "xHydro"
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: "software"
authors:
  - family-names: 'Fortier Filion'
    given-names: 'Thomas-Charles'
    email: 'tcff_hydro@outlook.com'
  - family-names: 'Rondeau-Genesse'
    given-names: 'Gabriel'
    email: 'rondeau-genesse.gabriel@ouranos.ca'
    orcid: "https://orcid.org/0000-0003-3389-9406"
  - family-names: 'Smith'
    given-names: 'Trevor James'
    email: 'smith.trevorj@ouranos.ca'
    orcid: "https://orcid.org/0000-0001-5393-8359"
  - family-name: 'Langlois'
    given-names: 'Sébastien'
  - family-names: 'Opina'
    given-names: 'Julián'
    orcid: "https://orcid.org/0000-0001-8582-3265"
  - family-names: 'Maarite'
    given-names: 'Kamil'
  - family-names: 'Arsenault'
    given-names: 'Richard'
    orcid: "https://orcid.org/0000-0003-2834-2750"
  - family-names: 'Gravel'
    given-names: 'Francis'
  - family-names: "Arnal"
    given-names: "Louise"
    orcid: "https://orcid.org/0000-0002-0208-2324"
  - family-names: 'Parent'
    given-names: 'Essi'
contact:
  - family-names: 'Fortier Filion'
    given-names: 'Thomas-Charles'
    email: 'tcff_hydro@outlook.com'
  - family-names: 'Rondeau-Genesse'
    given-names: 'Gabriel'
    email: 'rondeau-genesse.gabriel@ouranos.ca'
    orcid: "https://orcid.org/0000-0003-3389-9406"
repository-code: "https://github.com/hydrologie/xHydro"
abstract: "Hydrological analysis library built with xarray."
license: "Apache-2.0"
version: "0.8.1"

---

Owner metadata

• Name: hydrologie
• Login: hydrologie
• Email:
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/64544854?v=4
• Repositories: 1
• Last ynced at: 2023-05-01T21:32:30.784Z
• Profile URL: https://github.com/hydrologie

---

GitHub Events

Total

• Create event: 133
• Delete event: 133
• Fork event: 1
• Issue comment event: 133
• Issues event: 33
• Member event: 4
• Pull request event: 271
• Pull request review comment event: 149
• Pull request review event: 210
• Push event: 673
• Release event: 4
• Watch event: 31

Last Year

• Create event: 37
• Delete event: 40
• Issue comment event: 21
• Issues event: 6
• Pull request event: 95
• Pull request review comment event: 27
• Pull request review event: 34
• Push event: 159
• Release event: 3
• Watch event: 2

---

Committers metadata

Last synced: 1 day ago

Name	Email	Commits
RondeauG	r****l@o****a	548
Trevor James Smith	1****e	480
TC-FF	t****o@o****m	168
ospinajulian	o****s@o****m	161
dependabot[bot]	4****]	158
pre-commit-ci[bot]	6****]	105
richardarsenault	r****t@e****a	62
sebastienlanglois	s****s@p****a	52
Kamil Maarite	k****e@p****a	44
e-larose	e****r@g****m	43
bumpversion[bot]	b****]@h****m	35
Thomas-Charles Fortier Filion	f****s@m****a	28
Gabriel Rondeau	r****u@h****a	26
Francis Gravel	f****l@g****m	21
Essi Parent	9****f@r****m	7
lou-a	l****l@h****r	6
jougla.renaud	j****d@m****a	5
Antoine Lefebvre-Brossard	a****b@p****m	4
ospinallano.julianandres	o****s@m****a	3
Rondeau-Genesse	g****1@o****a	3
elysefournier	4****r	2
update-github-actions[bot]	b****]@o****a	1
RJougla	r****a@g****m	1

Committer domains:

• mdo.hydro.qc.ca: 3
• ouranos.ca: 3
• polymtl.ca: 2
• relay.firefox.com: 1
• halia.ouranos.ca: 1
• hydrologie.com: 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/hydrologie/xhydro

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 103 last-month
• Total dependent packages: 0 (may contain duplicates)
• Total dependent repositories: 0 (may contain duplicates)
• Total versions: 49
• Total maintainers: 3

Score: 12.116421423577528