.. image:: https://github.com/timcera/hspf_utils/actions/workflows/python-package.yml/badge.svg
:alt: Tests
:target: https://github.com/timcera/hspf_utils/actions/workflows/python-package.yml
:height: 20
.. image:: https://img.shields.io/coveralls/github/timcera/hspf_utils
:alt: Test Coverage
:target: https://coveralls.io/r/timcera/hspf_utils?branch=master
:height: 20
.. image:: https://img.shields.io/pypi/v/hspf_utils.svg
:alt: Latest release
:target: https://pypi.python.org/pypi/hspf_utils/
:height: 20
.. image:: https://img.shields.io/pypi/l/hspf_utils.svg
:alt: BSD-3 clause license
:target: https://pypi.python.org/pypi/hspf_utils/
:height: 20
.. image:: https://img.shields.io/pypi/dd/hspf_utils.svg
:alt: hspf_utils downloads
:target: https://pypi.python.org/pypi/hspf_utils/
:height: 20
.. image:: https://img.shields.io/pypi/pyversions/hspf_utils
:alt: PyPI - Python Version
:target: https://pypi.org/project/hspf_utils/
:height: 20
hspf_utils - Quick Guide
========================
The hspf_utils is a command line script and Python library of utilities to work
with the Hydrological Simulation Program - FORTRAN (HSPF). Uses pandas
(http://pandas.pydata.org/) or numpy (http://numpy.scipy.org) for any heavy
lifting.
Requirements
------------
* hspfbintoolbox - Utility to extract time-series from HSFP binary output
files; collected and installed by 'pip' or 'easy_install' command.
Installation
------------
Should be as easy as running ``pip install hspf_utils`` or
``conda install -c conda-forge hspf_utils`` at any command line.
Usage - Command Line
--------------------
Just run 'hspf_utils --help' to get a list of subcommands::
usage: hspf_utils [-h] {about,detailed,summary,mapping,parameters} ...
positional arguments:
{about,detailed,summary,mapping,parameters}
about Display version number and system information.
detailed Develops a detailed water balance.
summary Develops a summary water balance.
mapping Develops a csv file appropriate for joining to a GIS
layer.
parameters Develops a table of parameter values.
optional arguments:
-h, --help show this help message and exit
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 hspf_utils::
import hspf_utils
# Then you could call the functions
ntsd = hspf_utils.summary("test.hbn", uci="test.uci")
Raw data
{
"_id": null,
"home_page": null,
"name": "hspf-utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "python, cli-app, hspf, watershed, hydrology, hydrologic, simulation",
"author": null,
"author_email": "Tim Cera <tim@cerazone.net>",
"download_url": "https://files.pythonhosted.org/packages/c7/fd/c84d90a069fde769b93160129be3e617ba13f1b51fd3352d5b252a57a48b/hspf_utils-6.0.8.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/timcera/hspf_utils/actions/workflows/python-package.yml/badge.svg\n :alt: Tests\n :target: https://github.com/timcera/hspf_utils/actions/workflows/python-package.yml\n :height: 20\n\n.. image:: https://img.shields.io/coveralls/github/timcera/hspf_utils\n :alt: Test Coverage\n :target: https://coveralls.io/r/timcera/hspf_utils?branch=master\n :height: 20\n\n.. image:: https://img.shields.io/pypi/v/hspf_utils.svg\n :alt: Latest release\n :target: https://pypi.python.org/pypi/hspf_utils/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/l/hspf_utils.svg\n :alt: BSD-3 clause license\n :target: https://pypi.python.org/pypi/hspf_utils/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/dd/hspf_utils.svg\n :alt: hspf_utils downloads\n :target: https://pypi.python.org/pypi/hspf_utils/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/pyversions/hspf_utils\n :alt: PyPI - Python Version\n :target: https://pypi.org/project/hspf_utils/\n :height: 20\n\nhspf_utils - Quick Guide\n========================\nThe hspf_utils is a command line script and Python library of utilities to work\nwith the Hydrological Simulation Program - FORTRAN (HSPF). Uses pandas\n(http://pandas.pydata.org/) or numpy (http://numpy.scipy.org) for any heavy\nlifting.\n\nRequirements\n------------\n* hspfbintoolbox - Utility to extract time-series from HSFP binary output\n files; collected and installed by 'pip' or 'easy_install' command.\n\nInstallation\n------------\nShould be as easy as running ``pip install hspf_utils`` or\n``conda install -c conda-forge hspf_utils`` at any command line.\n\nUsage - Command Line\n--------------------\nJust run 'hspf_utils --help' to get a list of subcommands::\n\n usage: hspf_utils [-h] {about,detailed,summary,mapping,parameters} ...\n\n positional arguments:\n {about,detailed,summary,mapping,parameters}\n about Display version number and system information.\n detailed Develops a detailed water balance.\n summary Develops a summary water balance.\n mapping Develops a csv file appropriate for joining to a GIS\n layer.\n parameters Develops a table of parameter values.\n\n optional arguments:\n -h, --help show this help message and exit\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 hspf_utils::\n\n import hspf_utils\n\n # Then you could call the functions\n\n ntsd = hspf_utils.summary(\"test.hbn\", uci=\"test.uci\")\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Command line script and Python library to develop water balance from HSPF models",
"version": "6.0.8",
"project_urls": {
"bitbucket": "https://bitbucket.org/timcera/hspf_utils/src/main/",
"documentation": "https://timcera.bitbucket.io/hspf_utils/docs/index.html#hspf_utils-documentation",
"github": "https://github.com/timcera/hspf_utils"
},
"split_keywords": [
"python",
" cli-app",
" hspf",
" watershed",
" hydrology",
" hydrologic",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d80fa4d7b82becaeafd174bba8117a233eb33dbe4771931a1091a82c2c67b011",
"md5": "5c06ba2816240535eb738f794cbc6524",
"sha256": "c174e5aa2ad743cd838bd96ae9a4d550d705dd1bfe246bcc09e9f4baac4d0d4d"
},
"downloads": -1,
"filename": "hspf_utils-6.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c06ba2816240535eb738f794cbc6524",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11113,
"upload_time": "2024-04-03T04:43:01",
"upload_time_iso_8601": "2024-04-03T04:43:01.569080Z",
"url": "https://files.pythonhosted.org/packages/d8/0f/a4d7b82becaeafd174bba8117a233eb33dbe4771931a1091a82c2c67b011/hspf_utils-6.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7fdc84d90a069fde769b93160129be3e617ba13f1b51fd3352d5b252a57a48b",
"md5": "4bacece2f743de37c495bc1a1d8d5685",
"sha256": "c8b8d99128629a383ab0e470c976b36c15016c6a5a9b9a38ce718228150875b2"
},
"downloads": -1,
"filename": "hspf_utils-6.0.8.tar.gz",
"has_sig": false,
"md5_digest": "4bacece2f743de37c495bc1a1d8d5685",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17002480,
"upload_time": "2024-04-03T04:42:57",
"upload_time_iso_8601": "2024-04-03T04:42:57.603540Z",
"url": "https://files.pythonhosted.org/packages/c7/fd/c84d90a069fde769b93160129be3e617ba13f1b51fd3352d5b252a57a48b/hspf_utils-6.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 04:42:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timcera",
"github_project": "hspf_utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hspf-utils"
}
JSON
