.. image:: https://github.com/timcera/swmmtoolbox/actions/workflows/pypi-package.yml/badge.svg
:alt: Tests
:target: https://github.com/timcera/swmmtoolbox/actions/workflows/pypi-package.yml
:height: 20
.. image:: https://img.shields.io/coveralls/github/timcera/swmmtoolbox
:alt: Test Coverage
:target: https://coveralls.io/r/timcera/swmmtoolbox?branch=master
:height: 20
.. image:: https://img.shields.io/pypi/v/swmmtoolbox.svg
:alt: Latest release
:target: https://pypi.python.org/pypi/swmmtoolbox/
:height: 20
.. image:: https://img.shields.io/pypi/l/swmmtoolbox.svg
:alt: BSD-3 clause license
:target: https://pypi.python.org/pypi/swmmtoolbox/
:height: 20
.. image:: https://img.shields.io/pypi/dd/swmmtoolbox.svg
:alt: swmmtoolbox downloads
:target: https://pypi.python.org/pypi/swmmtoolbox/
:height: 20
.. image:: https://img.shields.io/pypi/pyversions/swmmtoolbox
:alt: PyPI - Python Version
:target: https://pypi.org/project/swmmtoolbox/
:height: 20
swmmtoolbox - Overview
----------------------
The swmmtoolbox is a Python script to read the Storm Water Management Model
(SWMM) version 5 binary output files.
Requirements
============
Python - of course, version 3.7+.
Installation
============
The swmmtoolbox is available via pip or conda.
pip
~~~
.. code-block:: bash
pip install swmmtoolbox
conda
~~~~~
.. code-block:: bash
conda install -c conda-forge swmmtoolbox
Usage
-----
Command Line
============
Just run 'swmmtoolbox --help' to get a list of subcommands and options::
usage: swmmtoolbox [-h]
{about,catalog,extract,listdetail,listvariables,stdtoswmm5}
...
positional arguments:
{about,catalog,extract,listdetail,listvariables,stdtoswmm5}
about Display version number and system information.
catalog List the catalog of objects in output file.
extract Get the time series data for a particular object and
variable.
listdetail List nodes and metadata in output file.
listvariables List variables available for each type.
stdtoswmm5 Take the toolbox standard format and return SWMM5
format.
options:
-h, --help show this help message and exit
Python API
==========
Simply import swmmtoolbox::
import swmmtoolbox
ntsd = swmmtoolbox.extract("tests/frutal.out", "node,45,Hydraulic_head")
Raw data
{
"_id": null,
"home_page": null,
"name": "swmmtoolbox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "time-series, cli-app, swmm, stormwater, hydrograph, model, simulation, hydrology",
"author": null,
"author_email": "Tim Cera <tim@cerazone.net>",
"download_url": "https://files.pythonhosted.org/packages/99/d3/893a938b676c95e663cee16fa87d780db0ea6bf4303a638a60ad1b314bbb/swmmtoolbox-4.0.14.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/timcera/swmmtoolbox/actions/workflows/pypi-package.yml/badge.svg\n :alt: Tests\n :target: https://github.com/timcera/swmmtoolbox/actions/workflows/pypi-package.yml\n :height: 20\n\n.. image:: https://img.shields.io/coveralls/github/timcera/swmmtoolbox\n :alt: Test Coverage\n :target: https://coveralls.io/r/timcera/swmmtoolbox?branch=master\n :height: 20\n\n.. image:: https://img.shields.io/pypi/v/swmmtoolbox.svg\n :alt: Latest release\n :target: https://pypi.python.org/pypi/swmmtoolbox/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/l/swmmtoolbox.svg\n :alt: BSD-3 clause license\n :target: https://pypi.python.org/pypi/swmmtoolbox/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/dd/swmmtoolbox.svg\n :alt: swmmtoolbox downloads\n :target: https://pypi.python.org/pypi/swmmtoolbox/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/pyversions/swmmtoolbox\n :alt: PyPI - Python Version\n :target: https://pypi.org/project/swmmtoolbox/\n :height: 20\n\nswmmtoolbox - Overview\n----------------------\nThe swmmtoolbox is a Python script to read the Storm Water Management Model\n(SWMM) version 5 binary output files.\n\nRequirements\n============\nPython - of course, version 3.7+.\n\nInstallation\n============\nThe swmmtoolbox is available via pip or conda.\n\npip\n~~~\n.. code-block:: bash\n\n pip install swmmtoolbox\n\nconda\n~~~~~\n.. code-block:: bash\n\n conda install -c conda-forge swmmtoolbox\n\nUsage\n-----\n\nCommand Line\n============\nJust run 'swmmtoolbox --help' to get a list of subcommands and options::\n\n usage: swmmtoolbox [-h]\n {about,catalog,extract,listdetail,listvariables,stdtoswmm5}\n ...\n\n positional arguments:\n {about,catalog,extract,listdetail,listvariables,stdtoswmm5}\n about Display version number and system information.\n catalog List the catalog of objects in output file.\n extract Get the time series data for a particular object and\n variable.\n listdetail List nodes and metadata in output file.\n listvariables List variables available for each type.\n stdtoswmm5 Take the toolbox standard format and return SWMM5\n format.\n\n options:\n -h, --help show this help message and exit\n\nPython API\n==========\nSimply import swmmtoolbox::\n\n import swmmtoolbox\n\n ntsd = swmmtoolbox.extract(\"tests/frutal.out\", \"node,45,Hydraulic_head\")\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Command line script and Python library to read Storm Water Management Model binary output.",
"version": "4.0.14",
"project_urls": {
"bitbucket": "https://bitbucket.org/timcera/swmmtoolbox/src/main/",
"documentation": "https://timcera.bitbucket.io/swmmtoolbox/docs/index.html#swmmtoolbox-documentation",
"github": "https://github.com/timcera/swmmtoolbox"
},
"split_keywords": [
"time-series",
" cli-app",
" swmm",
" stormwater",
" hydrograph",
" model",
" simulation",
" hydrology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0eedb01261f820258271c205332ad83c6409cc7cbca01e16f169b20dc4127aa9",
"md5": "3a379c2caf2de0883da4ca37c1711851",
"sha256": "97266b8e0197ed089fcfba802ecc7ada012659d435fc3904598a0c4a6d57afd0"
},
"downloads": -1,
"filename": "swmmtoolbox-4.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a379c2caf2de0883da4ca37c1711851",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 63718,
"upload_time": "2024-06-13T05:19:30",
"upload_time_iso_8601": "2024-06-13T05:19:30.882494Z",
"url": "https://files.pythonhosted.org/packages/0e/ed/b01261f820258271c205332ad83c6409cc7cbca01e16f169b20dc4127aa9/swmmtoolbox-4.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99d3893a938b676c95e663cee16fa87d780db0ea6bf4303a638a60ad1b314bbb",
"md5": "edf3fe878b92499c080ec09a95a56e1b",
"sha256": "a7811ac2b950e6178418b30a61093a980e6ee24453861a64f6bd3ff8461de132"
},
"downloads": -1,
"filename": "swmmtoolbox-4.0.14.tar.gz",
"has_sig": false,
"md5_digest": "edf3fe878b92499c080ec09a95a56e1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1404311,
"upload_time": "2024-06-13T05:19:32",
"upload_time_iso_8601": "2024-06-13T05:19:32.705359Z",
"url": "https://files.pythonhosted.org/packages/99/d3/893a938b676c95e663cee16fa87d780db0ea6bf4303a638a60ad1b314bbb/swmmtoolbox-4.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-13 05:19:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timcera",
"github_project": "swmmtoolbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "swmmtoolbox"
}
JSON
