Skip to content

Latest commit

 

History

History
46 lines (25 loc) · 1.72 KB

README.rst

File metadata and controls

46 lines (25 loc) · 1.72 KB
Raw

Hydrograph-py

Hydrograph-py is a hydrological Python package that provides some tools for:

  1. Separation of flow time-series into peak flow and baseflow.
  2. Filtering of peak flow events given a minimum event duration.
  3. Calculation of peak event volumes.
  4. Calculation of maximum annual peak flow and maximum annual peak event volume.
  5. Extreme value analysis using GEV fitting and plotting functions.

Documentation

Reference documentation can be found here.

Installation

Hydrograph-py can be installed via conda:

conda install Hydrograph-py -c WilcoTerink

or via pip:

pip install Hydrograph-py

Using the Hydrograph-py

After installation, the functions from the python package can be imported by:

from Hydrograph.hydrograph import sepBaseflow, filterpeaks, maxFlowVolStats

from Hydrograph.extreme_analysis import exceed, fitGEV, plotPDF, plotCDF, plotGEV

Copyright

Copyright (C) 2019 Wilco Terink. Hydrograph-py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.