.. image:: https://github.com/timcera/hydrotoolbox/actions/workflows/python-package.yml/badge.svg
:alt: Tests
:target: https://github.com/timcera/hydrotoolbox/actions/workflows/python-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 - 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')
Raw data
{
"_id": null,
"home_page": null,
"name": "hydrotoolbox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"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/6d/5d/edcf529bb0695e4298be4f25f27f892db321d6045ebeacd0ef025d5acbed/hydrotoolbox-2.0.10.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/timcera/hydrotoolbox/actions/workflows/python-package.yml/badge.svg\n :alt: Tests\n :target: https://github.com/timcera/hydrotoolbox/actions/workflows/python-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\n\nUsage - Command Line\n--------------------\nJust run 'hydrotoolbox --help' to get a list of subcommands::\n\n\n usage: hydrotoolbox [-h] [-v] {baseflow_sep,recession,about} ...\n\n positional arguments:\n {baseflow_sep,recession,about}\n baseflow_sep baseflow_sep subcommand\n recession Recession coefficient.\n about Display version number and system information.\n\n optional arguments:\n -h, --help show this help message and exit\n -v, --version show program's version number and exit\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\nUsage - API\n-----------\nYou can use all of the command line subcommands as functions. The function\nsignature is identical to the command line subcommands. The return is always\na PANDAS DataFrame. Input can be a CSV or TAB separated file, or a PANDAS\nDataFrame and is supplied to the function via the 'input_ts' keyword.\n\nSimply import hydrotoolbox::\n\n from hydrotoolbox import hydrotoolbox\n\n # Then you could call the functions\n ntsd = hydrotoolbox.baseflow_sep(method='broughton', input_ts='tests/test_fill_01.csv')\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Command line script and Python library for analysis of flow time-series.",
"version": "2.0.10",
"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": "",
"digests": {
"blake2b_256": "01128cc08e5891f9974fb363247a15780bba9127a9ff3863d2b3fb064dfa77b2",
"md5": "44db54096d4c22790c4d9dec0e1dc19d",
"sha256": "b4b0090e07e28b1ab402e5b27bb1a84f3ce6259bd25cc5a2dc05dc6bda103723"
},
"downloads": -1,
"filename": "hydrotoolbox-2.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44db54096d4c22790c4d9dec0e1dc19d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 259215,
"upload_time": "2024-03-31T20:29:24",
"upload_time_iso_8601": "2024-03-31T20:29:24.737471Z",
"url": "https://files.pythonhosted.org/packages/01/12/8cc08e5891f9974fb363247a15780bba9127a9ff3863d2b3fb064dfa77b2/hydrotoolbox-2.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d5dedcf529bb0695e4298be4f25f27f892db321d6045ebeacd0ef025d5acbed",
"md5": "6215bd902d460a3d680b42c6b80014e2",
"sha256": "12a4e678c734b7daf187b2555462b6fbc608c8a73beca744e113110a40680421"
},
"downloads": -1,
"filename": "hydrotoolbox-2.0.10.tar.gz",
"has_sig": false,
"md5_digest": "6215bd902d460a3d680b42c6b80014e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5763826,
"upload_time": "2024-03-31T20:29:19",
"upload_time_iso_8601": "2024-03-31T20:29:19.621638Z",
"url": "https://files.pythonhosted.org/packages/6d/5d/edcf529bb0695e4298be4f25f27f892db321d6045ebeacd0ef025d5acbed/hydrotoolbox-2.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-31 20:29:19",
"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
