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')
Metadata
Release files for hydrotoolbox 2.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hydrotoolbox-2.0.8.tar.gz | 5.5 MB | Without provenance | Details for hydrotoolbox-2.0.8.tar.gz |
Release files / hydrotoolbox-2.0.8.tar.gz
| Download URL | hydrotoolbox-2.0.8.tar.gz |
|---|---|
| Size | 5.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0ff95cb564c2e8475eaf6640672d41bf28cf7de766202f4ad25c45ec28c13e50
|
|
BLAKE2b-256 checksum How to use checksums |
c3d8093cdec016185566d2711011529192dd35f4fb9748dd3e790f071c8e0a32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.11
|
Security for hydrotoolbox 2.0.8
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.