hspf-reader


Namehspf-reader JSON
Version 2.0.2 PyPI version JSON
download
home_pageNone
SummaryCommand line script and Python library to read HSPF WDM, binary, and plotgen time series.
upload_time2024-09-15 18:09:36
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseBSD-3-Clause
keywords time-series hspf simulation hydrology hydrologic python cli command line script cli-application
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://github.com/timcera/hspf_reader/actions/workflows/pypi-package.yml/badge.svg
    :alt: Tests
    :target: https://github.com/timcera/hspf_reader/actions/workflows/pypi-package.yml
    :height: 20

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

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

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

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

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

hspf_reader - Quick Guide
=========================
The hspf_reader is a pure Python module and command line script to read HSPF
time-series from WDM files, HSPF binary files, and HSPF plotgen files.

Use "wdmtoolbox" to create, examine, read, and write to WDM files.

Use "hspfbintoolbox" to catalog and read HSPF binary output files.

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

    pip install hspf_reader

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

    conda install -c conda-forge hspf_reader

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


    usage: hspf_reader [-h]
                     {wdm, hbn, plotgen, about} ...

    positional arguments:
      {wdm, hbn, plotgen, about}

    wdm
        Read HSPF WDM files.
    hbn
        Read HSPF binary files.
    plotgen
        Read HSPF plotgen files.
    about
        Display version number and system information.

    optional arguments:
      -h, --help            show this help message and exit

The output time-series data 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.

Simply import hspf_reader::

    from hspf_reader import hspf_reader

    # Then you could call the functions
    ntsd = hspf_reader.wdm('wdm_file.wdm', 202)

    # Once you have a PANDAS DataFrame you can use that as input to other
    # hspf_reader functions.
    ntsd = hspf_reader.hbn('hbn_file.hbn', "yearly", [,,,"TAET"])

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "hspf-reader",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "time-series, hspf, simulation, hydrology, hydrologic, python, cli, command line, script, cli-application",
    "author": null,
    "author_email": "Tim Cera <tim@cerazone.net>",
    "download_url": "https://files.pythonhosted.org/packages/ce/82/3c003afe88b8c23e96eb675846989cc694c2dd3938f87fea42089c50dcdc/hspf_reader-2.0.2.tar.gz",
    "platform": null,
    "description": ".. image:: https://github.com/timcera/hspf_reader/actions/workflows/pypi-package.yml/badge.svg\n    :alt: Tests\n    :target: https://github.com/timcera/hspf_reader/actions/workflows/pypi-package.yml\n    :height: 20\n\n.. image:: https://img.shields.io/coveralls/github/timcera/hspf_reader\n    :alt: Test Coverage\n    :target: https://coveralls.io/r/timcera/hspf_reader?branch=master\n    :height: 20\n\n.. image:: https://img.shields.io/pypi/v/hspf_reader.svg\n    :alt: Latest release\n    :target: https://pypi.python.org/pypi/hspf_reader/\n    :height: 20\n\n.. image:: http://img.shields.io/pypi/l/hspf_reader.svg\n    :alt: BSD-3 clause license\n    :target: https://pypi.python.org/pypi/hspf_reader/\n    :height: 20\n\n.. image:: http://img.shields.io/pypi/dd/hspf_reader.svg\n    :alt: hspf_reader downloads\n    :target: https://pypi.python.org/pypi/hspf_reader/\n    :height: 20\n\n.. image:: https://img.shields.io/pypi/pyversions/hspf_reader\n    :alt: PyPI - Python Version\n    :target: https://pypi.org/project/hspf_reader/\n    :height: 20\n\nhspf_reader - Quick Guide\n=========================\nThe hspf_reader is a pure Python module and command line script to read HSPF\ntime-series from WDM files, HSPF binary files, and HSPF plotgen files.\n\nUse \"wdmtoolbox\" to create, examine, read, and write to WDM files.\n\nUse \"hspfbintoolbox\" to catalog and read HSPF binary output files.\n\nInstallation\n------------\npip\n~~~\n.. code-block:: bash\n\n    pip install hspf_reader\n\nconda\n~~~~~\n.. code-block:: bash\n\n    conda install -c conda-forge hspf_reader\n\nUsage - Command Line\n--------------------\nJust run 'hspf_reader --help' to get a list of subcommands::\n\n\n    usage: hspf_reader [-h]\n                     {wdm, hbn, plotgen, about} ...\n\n    positional arguments:\n      {wdm, hbn, plotgen, about}\n\n    wdm\n        Read HSPF WDM files.\n    hbn\n        Read HSPF binary files.\n    plotgen\n        Read HSPF plotgen files.\n    about\n        Display version number and system information.\n\n    optional arguments:\n      -h, --help            show this help message and exit\n\nThe output time-series data is printed to the screen and you can then redirect\nto 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.\n\nSimply import hspf_reader::\n\n    from hspf_reader import hspf_reader\n\n    # Then you could call the functions\n    ntsd = hspf_reader.wdm('wdm_file.wdm', 202)\n\n    # Once you have a PANDAS DataFrame you can use that as input to other\n    # hspf_reader functions.\n    ntsd = hspf_reader.hbn('hbn_file.hbn', \"yearly\", [,,,\"TAET\"])\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Command line script and Python library to read HSPF WDM, binary, and plotgen time series.",
    "version": "2.0.2",
    "project_urls": {
        "bitbucket": "https://bitbucket.org/timcera/hspf_reader/src/main/",
        "documentation": "https://timcera.bitbucket.io/hspf_reader/docs/index.html#hspf_reader-documentation",
        "github": "https://github.com/timcera/hspf_reader"
    },
    "split_keywords": [
        "time-series",
        " hspf",
        " simulation",
        " hydrology",
        " hydrologic",
        " python",
        " cli",
        " command line",
        " script",
        " cli-application"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "736a08ec9383b9f23eb3e0fa7fe4967f919da3b7b5295e8f89755c3cfa5fc896",
                "md5": "9c59d5406de197305684c558d50e0b0a",
                "sha256": "da4e1a0480872f2c8c432a1817b19ef5b12182a4ae95b83e0d9b3c4213d1110a"
            },
            "downloads": -1,
            "filename": "hspf_reader-2.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c59d5406de197305684c558d50e0b0a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 61068,
            "upload_time": "2024-09-15T18:09:35",
            "upload_time_iso_8601": "2024-09-15T18:09:35.145924Z",
            "url": "https://files.pythonhosted.org/packages/73/6a/08ec9383b9f23eb3e0fa7fe4967f919da3b7b5295e8f89755c3cfa5fc896/hspf_reader-2.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce823c003afe88b8c23e96eb675846989cc694c2dd3938f87fea42089c50dcdc",
                "md5": "f690e73fac0a88ff94bcd6c420d0a124",
                "sha256": "0aee1da85cd39e899ba2ae38dd31f3a156d9a8ac898cfb73dfc57113a6da643f"
            },
            "downloads": -1,
            "filename": "hspf_reader-2.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f690e73fac0a88ff94bcd6c420d0a124",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 861195,
            "upload_time": "2024-09-15T18:09:36",
            "upload_time_iso_8601": "2024-09-15T18:09:36.706925Z",
            "url": "https://files.pythonhosted.org/packages/ce/82/3c003afe88b8c23e96eb675846989cc694c2dd3938f87fea42089c50dcdc/hspf_reader-2.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-15 18:09:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "timcera",
    "github_project": "hspf_reader",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hspf-reader"
}
        
Elapsed time: 0.29686s