Metadata-Version: 2.1
Name: ravenpy
Version: 0.3.1
Summary: A Python wrapper to setup and run the hydrologic modelling framework Raven.
Home-page: https://github.com/CSHS-CWRA/ravenpy
Author: David Huard
Author-email: huard.david@ouranos.ca
License: MIT license
Keywords: ravenpy
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: click
Requires-Dist: climpred (>=2.1)
Requires-Dist: dask (<=2021.02.0)
Requires-Dist: matplotlib
Requires-Dist: netCDF4
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: statsmodels
Requires-Dist: wheel
Requires-Dist: xarray
Requires-Dist: xclim (>=0.23)
Requires-Dist: xskillscore
Provides-Extra: dev
Requires-Dist: Click ; extra == 'dev'
Requires-Dist: Sphinx ; extra == 'dev'
Requires-Dist: affine ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: bump2version ; extra == 'dev'
Requires-Dist: clisops (>=0.5.1) ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: coveralls ; extra == 'dev'
Requires-Dist: fiona ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: gdal (==3.0.4) ; extra == 'dev'
Requires-Dist: geopandas (>=0.9.0) ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: lxml ; extra == 'dev'
Requires-Dist: owslib ; extra == 'dev'
Requires-Dist: pip ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pyproj (>=3.0.0) ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-runner ; extra == 'dev'
Requires-Dist: rasterio ; extra == 'dev'
Requires-Dist: rioxarray ; extra == 'dev'
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: shapely ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: watchdog ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: ipykernel ; extra == 'docs'
Requires-Dist: ipython ; extra == 'docs'
Requires-Dist: jupyter-client ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: pandoc ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-click ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: gis
Requires-Dist: affine ; extra == 'gis'
Requires-Dist: clisops (>=0.5.1) ; extra == 'gis'
Requires-Dist: fiona ; extra == 'gis'
Requires-Dist: gdal (==3.0.4) ; extra == 'gis'
Requires-Dist: geopandas (>=0.9.0) ; extra == 'gis'
Requires-Dist: lxml ; extra == 'gis'
Requires-Dist: owslib ; extra == 'gis'
Requires-Dist: pyproj (>=3.0.0) ; extra == 'gis'
Requires-Dist: rasterio ; extra == 'gis'
Requires-Dist: rioxarray ; extra == 'gis'
Requires-Dist: shapely ; extra == 'gis'

=======
RavenPy
=======


.. image:: https://img.shields.io/pypi/v/ravenpy.svg
        :target: https://pypi.python.org/pypi/ravenpy

..
    .. image:: https://img.shields.io/travis/CSHS-CWRA/ravenpy.svg
            :target: https://travis-ci.com/CSHS-CWRA/ravenpy

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

..
    .. image:: https://pyup.io/repos/github/CSHS-CWRA/ravenpy/shield.svg
            :target: https://pyup.io/repos/github/CSHS-CWRA/ravenpy/
            :alt: Updates


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


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


Features
--------

* Download and compile Raven with `pip`
* Configure, run and parse Raven outputs from Python
* Parallel simulations over parameters, models or watersheds
* 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`_.


Credits
-------

RavenPy's development has been funded by CANARIE_.

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


.. _`installation docs`: https://ravenpy.readthedocs.io/en/latest/installation.html
.. _Raven: http://raven.uwaterloo.ca
.. _Cookiecutter: https://github.com/audreyfeldroy/cookiecutter-pypackage
.. _`Ouranosinc/cookiecutter-pypackage`: https://github.com/Ouranosinc/cookiecutter-pypackage
.. _`CANARIE`: https://www.canarie.ca


=======
History
=======

0.3.1
-----

* Update external dependencies (Raven, OSTRICH) to facilitate Conda packaging.

0.3.0
-----

* Migration and refactoring of GIS and IO utilities (`utils.py`, `utilities/gis.py`) from RavenWPS to RavenPy.
* RavenPy can now be installed from PyPI without GIS dependencies (limited functionality).
* Hydro routing product is now supported from `geoserver.py` (a notebook has been added to demonstrate the new functions).
* New script `ravenpy aggregate-forcings-to-hrus` to aggregate NetCDF files and compute updated grid weights.
* Add the basis for a new routing emulator option (WIP).
* Add climpred verification capabilities.

0.2.3
-----

* Regionalisation data is now part of the package.
* Fix tests that were not using testdata properly.
* Add tests for external dataset access.
* `utilities.testdata.get_local_testdata` now raises an exception when it finds no dataset corresponding to the user pattern.

0.2.2
-----

* Set wcs.getCoverage timeout to 120 seconds.
* Fix `Raven.parse_results` logic when no flow observations are present and no diagnostic file is created.
* Fix ECCC test where input was cached and shadowed forecast input data.

0.2.1
-----

* Fix xarray caching bug in regionalization.

0.2.0
-----

* Refactoring of `ravenpy.utilities.testdata` functions.
* Bump xclim to 0.23.

0.1.7
-----

* Fix xarray caching bug affecting climatological ESP forecasts (#33).
* Fix deprecation issue with Fiona.

0.1.6 (2021-01-15)
------------------

* Correct installer bugs.

0.1.5 (2021-01-14)
------------------

* Release with docs.


0.1.0 (2020-12-20)
------------------

* First release on PyPI.


