.. image:: https://github.com/timcera/hydrotoolbox/actions/workflows/pypi-package.yml/badge.svg
:alt: Tests
:target: https://github.com/timcera/hydrotoolbox/actions/workflows/pypi-package.yml
:height: 20
.. image:: https://img.shields.io/coveralls/github/timcera/hydrotoolbox
:alt: Test Coverage
:target: https://coveralls.io/r/timcera/hydrotoolbox?branch=master
:height: 20
.. image:: https://img.shields.io/pypi/v/hydrotoolbox.svg
:alt: Latest release
:target: https://pypi.python.org/pypi/hydrotoolbox/
:height: 20
.. image:: https://img.shields.io/pypi/l/hydrotoolbox.svg
:alt: BSD-3 clause license
:target: https://pypi.python.org/pypi/hydrotoolbox/
:height: 20
.. image:: https://img.shields.io/pypi/dd/hydrotoolbox.svg
:alt: hydrotoolbox downloads
:target: https://pypi.python.org/pypi/hydrotoolbox/
:height: 20
.. image:: https://img.shields.io/pypi/pyversions/hydrotoolbox
:alt: PyPI - Python Version
:target: https://pypi.org/project/hydrotoolbox/
:height: 20
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
~~~
.. code-block:: bash
pip install hydrotoolbox
conda
~~~~~
.. code-block:: bash
conda install -c conda-forge hydrotoolbox
Usage - API
-----------
All functions return 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='boughton', input_ts='tests/test_fill_01.csv')
Usage - Command Line
--------------------
All functions are available from the command line. The command line
interface is a wrapper around the functions in the hydrotoolbox module. The
command line arguments match one-to-one with the function arguments.
To get help for the command line interface, run::
hydrotoolbox --help
Which gives you the following output::
usage: hydrotoolbox [-h] [-v]
{baseflow_sep, recession, flow_duration, storm_events,
indices, exceedance_time, about} ...
positional arguments:
{baseflow_sep,recession,flow_duration,storm_events,indices,exceedance_time,about}
baseflow_sep baseflow_sep subcommand
recession Recession coefficient.
flow_duration Flow duration.
storm_events Storm events.
indices Calculate hydrologic indices.
exceedance_time Calculate the time that a time series exceeds (or is
below) a threshold.
about Display version number and system information.
options:
-h, --help show this help message and exit
-v, --version show program's version number and exit
To get help for a specific subcommand, run::
hydrotoolbox <subcommand> --help
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "hydrotoolbox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "time-series, cli-app, hydrology, baseflow, hydrograph-recession, hydrographic",
"author": null,
"author_email": "Tim Cera <tim@cerazone.net>",
"download_url": "https://files.pythonhosted.org/packages/87/d9/315ab41e8103c75958349e616e4c2f54cffcfc210bfb618f8cc746d44877/hydrotoolbox-2.0.12.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/timcera/hydrotoolbox/actions/workflows/pypi-package.yml/badge.svg\n :alt: Tests\n :target: https://github.com/timcera/hydrotoolbox/actions/workflows/pypi-package.yml\n :height: 20\n\n.. image:: https://img.shields.io/coveralls/github/timcera/hydrotoolbox\n :alt: Test Coverage\n :target: https://coveralls.io/r/timcera/hydrotoolbox?branch=master\n :height: 20\n\n.. image:: https://img.shields.io/pypi/v/hydrotoolbox.svg\n :alt: Latest release\n :target: https://pypi.python.org/pypi/hydrotoolbox/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/l/hydrotoolbox.svg\n :alt: BSD-3 clause license\n :target: https://pypi.python.org/pypi/hydrotoolbox/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/dd/hydrotoolbox.svg\n :alt: hydrotoolbox downloads\n :target: https://pypi.python.org/pypi/hydrotoolbox/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/pyversions/hydrotoolbox\n :alt: PyPI - Python Version\n :target: https://pypi.org/project/hydrotoolbox/\n :height: 20\n\nhydrotoolbox - Quick Guide\n==========================\nThe hydrotoolbox is a Python script for hydrologic calculations and analysis\nor by function calls within Python. Uses pandas (http://pandas.pydata.org/)\nor numpy (http://numpy.scipy.org) for any heavy lifting.\n\nRequirements\n------------\n* python 3.7 or higher\n\nInstallation\n------------\npip\n~~~\n.. code-block:: bash\n\n pip install hydrotoolbox\n\nconda\n~~~~~\n.. code-block:: bash\n\n conda install -c conda-forge hydrotoolbox\n\nUsage - API\n-----------\nAll functions return a PANDAS DataFrame. Input can be a CSV or TAB separated\nfile, or a PANDAS DataFrame and is supplied to the function via the 'input_ts'\nkeyword.\n\nSimply import hydrotoolbox::\n\n from hydrotoolbox import hydrotoolbox\n\n # Then you could call the functions\n ntsd = hydrotoolbox.baseflow_sep(method='boughton', input_ts='tests/test_fill_01.csv')\n\nUsage - Command Line\n--------------------\nAll functions are available from the command line. The command line\ninterface is a wrapper around the functions in the hydrotoolbox module. The\ncommand line arguments match one-to-one with the function arguments.\n\nTo get help for the command line interface, run::\n\n hydrotoolbox --help\n\nWhich gives you the following output::\n\n usage: hydrotoolbox [-h] [-v]\n {baseflow_sep, recession, flow_duration, storm_events,\n indices, exceedance_time, about} ...\n\n positional arguments:\n {baseflow_sep,recession,flow_duration,storm_events,indices,exceedance_time,about}\n baseflow_sep baseflow_sep subcommand\n recession Recession coefficient.\n flow_duration Flow duration.\n storm_events Storm events.\n indices Calculate hydrologic indices.\n exceedance_time Calculate the time that a time series exceeds (or is\n below) a threshold.\n about Display version number and system information.\n\n options:\n -h, --help show this help message and exit\n -v, --version show program's version number and exit\n\nTo get help for a specific subcommand, run::\n\n hydrotoolbox <subcommand> --help\n\nThe default for all of the subcommands is to accept data from stdin (typically\na pipe). If a subcommand accepts an input file for an argument, you can use\n\"--input_ts=input_file_name.csv\", or to explicitly specify from stdin (the\ndefault) \"--input_ts='-'\".\n\nFor the subcommands that output data it is printed to the screen and you can\nthen redirect to a file.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Command line script and Python library for analysis of flow time-series.",
"version": "2.0.12",
"project_urls": {
"bitbucket": "https://bitbucket.org/timcera/hydrotoolbox/src/main/",
"documentation": "https://timcera.bitbucket.io/hydrotoolbox/docs/index.html#hydrotoolbox-documentation",
"github": "https://github.com/timcera/hydrotoolbox"
},
"split_keywords": [
"time-series",
" cli-app",
" hydrology",
" baseflow",
" hydrograph-recession",
" hydrographic"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0a86b0193fe52e32df80650a990129907c9213369c24049472c9591b82c71838",
"md5": "a65078b6d683120e5f1b0ca9755e5e8a",
"sha256": "b3a65d15756ae24a4ad165d539c4d561a65ba4239b1620c388dac3368ac9fcac"
},
"downloads": -1,
"filename": "hydrotoolbox-2.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a65078b6d683120e5f1b0ca9755e5e8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 256393,
"upload_time": "2025-04-29T14:39:53",
"upload_time_iso_8601": "2025-04-29T14:39:53.526954Z",
"url": "https://files.pythonhosted.org/packages/0a/86/b0193fe52e32df80650a990129907c9213369c24049472c9591b82c71838/hydrotoolbox-2.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "87d9315ab41e8103c75958349e616e4c2f54cffcfc210bfb618f8cc746d44877",
"md5": "7354cad6e0fd92373fcba76780ad3c9f",
"sha256": "ab2451073aef05d761ef70681d2d7b2072a946e6d9b0624ee18ba69e2d20e299"
},
"downloads": -1,
"filename": "hydrotoolbox-2.0.12.tar.gz",
"has_sig": false,
"md5_digest": "7354cad6e0fd92373fcba76780ad3c9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5761602,
"upload_time": "2025-04-29T14:39:55",
"upload_time_iso_8601": "2025-04-29T14:39:55.456625Z",
"url": "https://files.pythonhosted.org/packages/87/d9/315ab41e8103c75958349e616e4c2f54cffcfc210bfb618f8cc746d44877/hydrotoolbox-2.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-29 14:39:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timcera",
"github_project": "hydrotoolbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hydrotoolbox"
}
JSON
