Metadata-Version: 2.4
Name: xhydro
Version: 0.6.0
Summary: Hydrological analysis library built with xarray.
Keywords: xhydro
Author: Sébastien Langlois
Author-email: Thomas-Charles Fortier Filion <tcff_hydro@outlook.com>, Gabriel Rondeau-Genesse <rondeau-genesse.gabriel@ouranos.ca>
Maintainer-email: Trevor James Smith <smith.trevorj@ouranos.ca>, Gabriel Rondeau-Genesse <rondeau-genesse.gabriel@ouranos.ca>
Requires-Python: >=3.10.0
Description-Content-Type: text/x-rst
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Hydrology
License-File: LICENSE
Requires-Dist: cartopy >=0.23.0
Requires-Dist: dask
Requires-Dist: dask-geopandas
Requires-Dist: geopandas >=1.0
Requires-Dist: haversine >=2.8.1
Requires-Dist: leafmap
Requires-Dist: mapclassify
Requires-Dist: numpy >=1.24
Requires-Dist: pandas >=2.2
Requires-Dist: planetary-computer
Requires-Dist: pooch >=1.8.0
Requires-Dist: pystac >=1.12.0
Requires-Dist: pystac-client
Requires-Dist: pyyaml >=6.0.2
Requires-Dist: rasterio
Requires-Dist: rioxarray >=0.15.0
Requires-Dist: spotpy >=1.6.2
Requires-Dist: stackstac >=0.5.1
Requires-Dist: statsmodels >=0.14.0
Requires-Dist: tqdm
Requires-Dist: xarray >=2023.11.0
Requires-Dist: xarray-spatial >=0.3.7
Requires-Dist: xclim
Requires-Dist: xscen >=0.12.1,<0.14
Requires-Dist: xvec
Requires-Dist: xhydro[dev] ; extra == "all"
Requires-Dist: xhydro[docs] ; extra == "all"
Requires-Dist: xhydro[julia] ; extra == "all"
Requires-Dist: xhydro[raven] ; extra == "all"
Requires-Dist: black ==25.1.0 ; extra == "dev"
Requires-Dist: blackdoc ==0.4.1 ; extra == "dev"
Requires-Dist: bump-my-version >=0.32.1 ; extra == "dev"
Requires-Dist: coverage >=7.5.0 ; extra == "dev"
Requires-Dist: flake8 >=7.1.1 ; extra == "dev"
Requires-Dist: flake8-rst-docstrings >=0.3.0 ; extra == "dev"
Requires-Dist: flit >=3.10.1,<4.0 ; extra == "dev"
Requires-Dist: isort ==6.0.1 ; extra == "dev"
Requires-Dist: mypy >=1.14.1 ; extra == "dev"
Requires-Dist: numpydoc >=1.8.0 ; extra == "dev"
Requires-Dist: packaging >=23.0 ; extra == "dev"
Requires-Dist: pip >=25.0 ; extra == "dev"
Requires-Dist: pre-commit >=3.5.0 ; extra == "dev"
Requires-Dist: pytest >=8.3.2 ; extra == "dev"
Requires-Dist: pytest-cov >=5.0.0 ; extra == "dev"
Requires-Dist: pytest-xdist[psutil] >=3.2 ; extra == "dev"
Requires-Dist: ruff >=0.9.0 ; extra == "dev"
Requires-Dist: tox >=4.24.1 ; extra == "dev"
Requires-Dist: watchdog >=4.0.0 ; extra == "dev"
Requires-Dist: xdatasets >=0.3.8 ; extra == "dev"
Requires-Dist: furo ; extra == "docs"
Requires-Dist: hvplot ; extra == "docs"
Requires-Dist: ipykernel ; extra == "docs"
Requires-Dist: ipython >=8.5.0 ; extra == "docs"
Requires-Dist: jupyter_client ; extra == "docs"
Requires-Dist: nbsphinx >=0.9.5 ; extra == "docs"
Requires-Dist: nbval ; extra == "docs"
Requires-Dist: sphinx >=7.1.0,<8.2.0 ; extra == "docs"
Requires-Dist: sphinx-codeautolink >=0.16.2 ; extra == "docs"
Requires-Dist: sphinx-copybutton ; extra == "docs"
Requires-Dist: sphinx-intl ; extra == "docs"
Requires-Dist: xagg ; extra == "docs"
Requires-Dist: juliacall >=0.9.20 ; extra == "julia"
Requires-Dist: ravenpy[raven-hydro] >=0.18.1 ; extra == "raven"
Project-URL: Changelog, https://xhydro.readthedocs.io/en/stable/changelog.html
Project-URL: Homepage, https://xhydro.readthedocs.io/
Project-URL: Issue tracker, https://github.com/hydrologie/xhydro/issues
Project-URL: Source, https://github.com/hydrologie/xhydro
Provides-Extra: all
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: julia
Provides-Extra: raven

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

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi| |versions|                                   |
+----------------------------+-----------------------------------------------------+
| Documentation and Support  | |docs|                                              |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |ossf-score|                              |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |black| |isort| |ruff| |pre-commit|                 |
+----------------------------+-----------------------------------------------------+
| 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

.. |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/hydrologie/xhydro/actions/workflows/main.yml/badge.svg
        :target: https://github.com/hydrologie/xhydro/actions
        :alt: Build Status

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

..
    .. |docs| image:: https://img.shields.io/badge/Docs-GitHub.io-blue
            :target: https://hydrologie.github.io/xhydro/
            :alt: Documentation Status

.. |docs| image:: https://readthedocs.org/projects/xhydro/badge/?version=latest
        :target: https://xhydro.readthedocs.io/en/latest/?version=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/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| 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

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

