Merge pull request #27 from hydrologie/local_changes

major refactoring of local.py

.zenodo.json

@@ -13,6 +13,9 @@
       "name": "Rondeau-Genesse, Gabriel",
       "affiliation": "Ouranos, Montréal, Québec, Canada",
       "orcid": "0000-0003-3389-9406"
+    },
+    {
+      "name": "Langlois, Sébastien"
     }
   ],
   "keywords": [

AUTHORS.rst

@@ -12,6 +12,7 @@ Co-Developers
 
 * Trevor James Smith <smith.trevorj@ouranos.ca> `@Zeitsperre <https://github.com/Zeitsperre>`_
 * Gabriel Rondeau-Genesse <rondeau-genesse.gabriel@ouranos.ca> `@RondeauG <https://github.com/RondeauG>`_
+* Sébastien Langlois <todo> `@sebastienlanglois <https://github.com/sebastienlanglois>`_
 
 Contributors
 ------------

HISTORY.rst

@@ -4,17 +4,20 @@ History
 
 v0.2.0 (unreleased)
 -------------------
-Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Gabriel Rondeau-Genesse (:user:`RondeauG`).
+Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Gabriel Rondeau-Genesse (:user:`RondeauG`), Thomas-Charles Fortier Filion (:user:`TC-FF`), Sébastien Langlois (:user:`sebastienlanglois`)
 
 Announcements
 ^^^^^^^^^^^^^
 * Support for Python3.8 and lower has been dropped. (:pull:`11`).
 * `xHydro` now hosts its documentation on `Read the Docs <https://xhydro.readthedocs.io/en/latest/>`_. (:issue:`22`, :pull:`26`).
+* Local frequency analysis functions have been added under a new module `xhydro.frequency_analysis`. (:pull:`20`, :pull:`27`).
 
 New features and enhancements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 * GitHub Workflows for automated testing using `tox` have been added. (:pull:`11`).
 * Support for various `xscen` functions has been added to compute indicators and various climate change metrics. (:pull:`21`).
+* New function `xh.indicators.compute_volume` to convert streamflow data to volumes. (:pull:`20`, :pull:`27`).
+* New function `xh.indicators.get_yearly_op` to compute block operation (e.g. block maxima, minima, etc.). (:pull:`20`, :pull:`27`).
 
 Breaking changes
 ^^^^^^^^^^^^^^^^
@@ -39,6 +42,7 @@ Internal changes
 * Deployments to TestPyPI and PyPI are now run using GitHub Workflow Environments as a safeguarding mechanism. (:pull:`28`).
 * Various cleanups of the environment files. (:issue:`23`, :pull:`30`).
 * `xhydro` now uses the trusted publishing mechanism for PyPI and TestPyPI deployment. (:pull:`32`).
+* Added tests. (:pull:`27`).
 
 0.1.2 (2023-05-10)
 ------------------

MANIFEST.in

@@ -6,6 +6,7 @@ include README.rst
 include .zenodo.json
 
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+recursive-include docs *.ipynb
 recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

docs/index.rst

@@ -4,17 +4,19 @@ Welcome to xHydro's documentation!
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
+   :hidden:
 
    readme
    installation
    usage
+   notebooks/local_frequency_analysis
    apidoc/modules
    contributing
    authors
    history
 
-Indices and tables
-==================
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. Indices and tables
+.. ==================
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`

docs/installation.rst

@@ -15,7 +15,7 @@ To create a working environment and install xHydro, copy the `environment.yml` f
 
 This is the preferred method to install `xHydro`, as it will always install the most recent stable release.
 
-If for some reason you wish to install the `PyPI` version of `xscen` into an existing Anaconda environment (*not recommended*), only run the last command above.
+If for some reason you wish to install the `PyPI` version of `xhydro` into an existing Anaconda environment (*not recommended if requirements are not met*), only run the last command above.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide you through the process.