hspfbintoolbox

A Python script and library of functions to read Hydrological Simulation Program Fortran (HSPF) binary files and print to screen.
https://github.com/timcera/hspfbintoolbox

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

cli hydrology python simulation

Keywords from Contributors

measur transformer humidity generic wind data-management watershed observation evaporation feature-toggles

Last synced: about 14 hours ago
JSON representation

Repository metadata

Command line script and Python package to read time-series from the Hydrological Simulation Program - FORTRAN (HSPF) binary output.

• Host: GitHub
• URL: https://github.com/timcera/hspfbintoolbox
• Owner: timcera
• License: bsd-3-clause
• Created: 2014-12-14T07:34:53.000Z (over 10 years ago)
• Default Branch: develop
• Last Pushed: 2025-02-27T06:37:53.000Z (about 2 months ago)
• Last Synced: 2025-04-13T06:02:23.350Z (14 days ago)
• Topics: cli, hydrology, python, simulation
• Language: Python
• Homepage:
• Size: 16.3 MB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Releases: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt
  • Authors: AUTHORS.rst

README.rst

          .. image:: https://github.com/timcera/hspfbintoolbox/actions/workflows/pypi-package.yml/badge.svg
    :alt: Tests
    :target: https://github.com/timcera/hspfbintoolbox/actions/workflows/pypi-package.yml
    :height: 20

.. image:: https://img.shields.io/coveralls/github/timcera/hspfbintoolbox
    :alt: Test Coverage
    :target: https://coveralls.io/r/timcera/hspfbintoolbox?branch=master
    :height: 20

.. image:: https://img.shields.io/pypi/v/hspfbintoolbox.svg
    :alt: Latest release
    :target: https://pypi.python.org/pypi/hspfbintoolbox/
    :height: 20

.. image:: http://img.shields.io/pypi/l/hspfbintoolbox.svg
    :alt: BSD-3 clause license
    :target: https://pypi.python.org/pypi/hspfbintoolbox/
    :height: 20

.. image:: http://img.shields.io/pypi/dd/hspfbintoolbox.svg
    :alt: hspfbintoolbox downloads
    :target: https://pypi.python.org/pypi/hspfbintoolbox/
    :height: 20

.. image:: https://img.shields.io/pypi/pyversions/hspfbintoolbox
    :alt: PyPI - Python Version
    :target: https://pypi.org/project/hspfbintoolbox/
    :height: 20

Documentation for hspfbintoolbox
================================
The ``hspfbintoolbox`` is a Python script and library of functions to read
Hydrological Simulation Program Fortran (HSPF) binary files and print to
screen.  The time series can then be redirected to file, or piped to other
command line programs like ``tstoolbox``.

Requirements
------------

* python 3.7 or later

* tstoolbox - utilities to process time-series

Installation
------------
pip
~~~
.. code-block:: bash

    pip install hspfbintoolbox

conda
~~~~~
.. code-block:: bash

    conda install -c conda-forge hspfbintoolbox


Usage - Command Line
--------------------
Just run 'hspfbintoolbox --help' to get a list of subcommands:

 catalog
          Prints out a catalog of data sets in the binary file.

 extract
          Prints out data to the screen from a HSPF binary output file.

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 hspfbintoolbox::

    import hspfbintoolbox

    # Then you could call the functions
    ntsd = hspfbintoolbox.extract('tests/test.hbn', 'yearly', ',905,,AGWS')

    # Once you have a PANDAS DataFrame you can use that as input.
    ntsd = tstoolbox.aggregate(statistic='mean', agg_interval='daily', input_ts=ntsd)

        

---

Owner metadata

• Name: Tim Cera
• Login: timcera
• Email:
• Kind: user
• Description: Florida Professional Engineer working in water resources. I program to support data analysis and model simulations.
• Website: https://timcera.bitbucket.io/
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/297142?u=98f35811432817f10222cb6334f64ceef78802b4&v=4
• Repositories: 69
• Last ynced at: 2024-06-11T15:37:40.366Z
• Profile URL: https://github.com/timcera

---

GitHub Events

Total

• Push event: 5

Last Year

• Push event: 5

---

Committers metadata

Last synced: 5 days ago

Name	Email	Commits
Tim Cera	t****m@c****t	198
dependabot[bot]	4****]	2
DeepSource Bot	b****t@d****o	2
thomas jobes	t****s@s****m	1
sourcery-ai[bot]	5****]	1
Timothy Cera	t****a@n****v	1
Tim Cera	t****a@s****m	1
Sourcery AI		1

Committer domains:

• sjrwmd.com: 2
• noaa.gov: 1
• deepsource.io: 1
• cerazone.net: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/timcera/hspfbintoolbox

---

---

---

Dependencies

Score: 4.1588830833596715