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.10 or higher
Installation
pip
pip install hydrotoolboxconda
conda install -c conda-forge hydrotoolboxUsage - 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.
1 maintainer
Release files for hydrotoolbox 2.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hydrotoolbox-2.3.2.tar.gz | 1.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hydrotoolbox-2.3.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.9 MB
Release files / hydrotoolbox-2.3.2.tar.gz
| Download URL | hydrotoolbox-2.3.2.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7d4a8cd8ae6c959e889d30d5984dcfb4982f3d0ff685513b9f16d45705d6e45a
|
|
BLAKE2b-256 checksum How to use checksums |
024a8d3ced3f99a33f7d72e8de4133d8882632932944d1ed9c67d7200fcf3ddb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency logRelease files / hydrotoolbox-2.3.2-py3-none-any.whl
| Download URL | hydrotoolbox-2.3.2-py3-none-any.whl |
|---|---|
| Size | 263.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f5f14769bbcc989a32985970acb08a50faa18d5978475617be1896ebd1ed90be
|
|
BLAKE2b-256 checksum How to use checksums |
8a39e55f1c68405327ee52ca91087a9c9d4239cb9dad55090cb3588b4b18965a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency log
