Command line script and Python library for analysis of flow time-series.
Project description
hydrotoolbox - Quick Guide
The hydrotoolbox is a Python script for hydrologic calculations and analysis or by function calls within Python. Uses pandas (http://pandas.pydata.org/) or numpy (http://numpy.scipy.org) for any heavy lifting.
Requirements
python 3.7 or higher
Installation
pip
pip install hydrotoolbox
conda
conda install -c conda-forge hydrotoolbox
Usage - Command Line
Just run ‘hydrotoolbox –help’ to get a list of subcommands:
usage: hydrotoolbox [-h] [-v] {baseflow_sep,recession,about} ... positional arguments: {baseflow_sep,recession,about} baseflow_sep baseflow_sep subcommand recession Recession coefficient. about Display version number and system information. optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit
The default for all of the subcommands is to accept data from stdin (typically a pipe). If a subcommand accepts an input file for an argument, you can use “–input_ts=input_file_name.csv”, or to explicitly specify from stdin (the default) “–input_ts=’-‘”.
For the subcommands that output data it is printed to the screen and you can then redirect to a file.
Usage - API
You can use all of the command line subcommands as functions. The function signature is identical to the command line subcommands. The return is always a PANDAS DataFrame. Input can be a CSV or TAB separated file, or a PANDAS DataFrame and is supplied to the function via the ‘input_ts’ keyword.
Simply import hydrotoolbox:
from hydrotoolbox import hydrotoolbox # Then you could call the functions ntsd = hydrotoolbox.baseflow_sep(method='broughton', input_ts='tests/test_fill_01.csv')
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hydrotoolbox-2.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4b0090e07e28b1ab402e5b27bb1a84f3ce6259bd25cc5a2dc05dc6bda103723 |
|
MD5 | 44db54096d4c22790c4d9dec0e1dc19d |
|
BLAKE2b-256 | 01128cc08e5891f9974fb363247a15780bba9127a9ff3863d2b3fb064dfa77b2 |