Metadata-Version: 2.1
Name: pyswmm
Version: 1.3.0
Summary: Python Wrapper for SWMM5 API
Home-page: https://github.com/OpenWaterAnalytics/pyswmm/wiki
Author: Bryant E. McDonnell (See AUTHORS)
License: BSD2 License
Keywords: swmm5,swmm,hydraulics,hydrology,modeling,collection system
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Documentation :: Sphinx
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python
Classifier: Development Status :: 5 - Production/Stable
License-File: LICENSE.txt
License-File: AUTHORS

PYSWMM
======


|gh actions| |docs| |license| |pypi version| |downloads| |cite|

*Python Wrapper for Stormwater Management Model (SWMM5)*

Website
	`www.pyswmm.org <https://www.pyswmm.org>`_
Video Tutorial Series:
	`PySWMM YouTube Channel <https://www.youtube.com/channel/UCv-OYsz2moiMRzZIRhqbpHA/featured>`_
Documentation
	`PySWMM Documentation <http://pyswmm.readthedocs.io/en/latest/>`_
Examples
	`PySWMM Example Bundles <https://www.pyswmm.org/examples>`_
ðŸ†˜Do you need HELP?ðŸ†˜ 
	We provide support on `Stack Overflow <https://stackoverflow.com/search?q=pyswmm>`_ or `GitHub Discussions <https://github.com/OpenWaterAnalytics/pyswmm/discussions>`_ to answer support questions related to PySWMM.
Cite our Paper
	McDonnell, Bryant E., Ratliff, Katherine M., Tryby, Michael E., Wu, Jennifer Jia Xin, & Mullapudi, Abhiram. (2020). PySWMM: The Python Interface to Stormwater Management Model (SWMM). *Journal of Open Source Software, 5*\ (52), 2292, https://doi.org/10.21105/joss.02292

YouTube Training Vidoes
-----------------------

Setting a manhole inflow during a running simulation!
	.. image:: http://img.youtube.com/vi/av8L5gNSBvI/0.jpg
	  :target: https://youtu.be/av8L5gNSBvI

Overview
--------

PySWMM is a Python language software package for the creation,
manipulation, and study of the structure, dynamics, and function of complex networks.

With PySWMM you can load and manipulate USEPA Stormwater Management Models.
With the development of PySWMM, control algorithms can now be developed exclusively
in Python which allows the use of functions and objects as well as storing and
tracking hydraulic trends for control actions.

As of version v1.1.0, PySWMM includes new features to process metadata and timeseries
stored in SWMM binary output file.

Who uses PySWMM?
----------------

PySWMM is used by engineers, modelers, and researchers who want to streamline
stormwater modeling optimization, controls, and post-processing results.

Goals
-----
PySWMM is intended to provide

-  tools for the study of the structure and
   dynamics within USEPA SWMM5,

-  a standard programming interface and graph implementation that is suitable
   for many applications,

-  a rapid development environment for collaborative, multidisciplinary
   projects,

-  an interface to USEPA SWMM5,

-  development and implementation of control logic outside of native EPA-SWMM Controls,

-  methods for users to establish their own node inflows,

-  a coding interface to binary output files,

-  new modeling possibilities for the SWMM5 Community.

Install
-------

Get the latest version of PySWMM from `PyPI <https://pypi.python.org/pypi/pyswmm/>`_ See the `Quick Guide <https://www.pyswmm.org/docs>`_!

::

	$ pip install pyswmm

Usage
-----

A quick example that steps through a simulation:

Examples:

See the `Latte Example <https://www.pyswmm.org/examples>`_

.. code-block:: python

    from pyswmm import Simulation, Nodes, Links

    with Simulation(r'Example1.inp') as sim:
        Node21 = Nodes(sim)["21"]
        print("Invert Elevation: {}". format(Node21.invert_elevation))

        Link15 = Links(sim)['15']
        print("Outlet Node ID: {}".format(Link15.outlet_node))

        # Launch a simulation!
        for ind, step in enumerate(sim):
            if ind % 100 == 0:
                print(sim.current_time,",",round(sim.percent_complete*100),"%",\
                      Node21.depth, Link15.flow)

Opening a SWMM binary output file and accessing model metadata and
timeseries.

.. code-block:: python

    from swmm.toolkit.shared_enum import SubcatchAttribute, NodeAttribute, LinkAttribute
    from pyswmm import Output

    with Output('model.out') as out:
        print(len(out.subcatchments))
        print(len(out.nodes))
        print(len(out.links))
        print(out.version)
        sub_ts = out.subcatch_series('S1', SubcatchAttribute.RUNOFF_RATE)
        node_ts = out.node_series('J1', NodeAttribute.INVERT_DEPTH)
        link_ts = out.link_series('C2', LinkAttribute.FLOW_RATE)

Bugs
----

Our issue tracker is at https://github.com/OpenWaterAnalytics/pyswmm/issues.
Please report any bugs that you find.  Or, even better, fork the repository on
GitHub and create a pull request.  All changes are welcome, big or small, and we
will help you make the pull request if you are new to git
(just ask on the issue).

Contributing
------------
Please check out our Wiki https://github.com/OpenWaterAnalytics/pyswmm/wiki
for more information on contributing, including an Author Contribution Checklist.

License
-------

Distributed with a BSD2 license; see LICENSE.txt::

   Copyright (C) 2014-2023 PySWMM Developers
   Community-Owned See AUTHORS and CITATION.cff

Acknowledgements
----------------

- Assela Pathirana

.. |appveyor status| image:: https://ci.appveyor.com/api/projects/status/gm3ci07gmkoyaeol/branch/master?svg=true
   :target: https://ci.appveyor.com/project/bemcdonnell/pyswmm
   :alt: Appveyor build status
.. |travisci status| image:: https://travis-ci.org/OpenWaterAnalytics/pyswmm.svg?branch=master
   :target: https://travis-ci.org/OpenWaterAnalytics/pyswmm
   :alt: Travis-CI build status
.. |gh actions| image:: https://github.com/OpenWaterAnalytics/pyswmm/actions/workflows/python-package.yml/badge.svg?branch=master
   :target: https://github.com/OpenWaterAnalytics/pyswmm/actions/workflows/python-package.yml
   :alt: GitHub Actions Build Status
.. |downloads| image:: https://img.shields.io/badge/dynamic/json.svg?label=Downloads&url=https%3A%2F%2Fpypistats.org%2Fapi%2Fpackages%2Fpyswmm%2Frecent&query=%24.data.last_month&colorB=green&suffix=%20last%20month
   :target: https://pypi.python.org/pypi/pyswmm/
   :alt: PyPI Monthly Downloads
.. |license| image:: https://img.shields.io/pypi/l/pyswmm.svg
   :target: LICENSE.txt
   :alt: License
.. |pypi version| image:: https://img.shields.io/pypi/v/pyswmm.svg
   :target: https://pypi.python.org/pypi/pyswmm/
   :alt: Latest PyPI version
.. |docs| image:: https://readthedocs.org/projects/pyswmm/badge/?version=latest
   :target: http://pyswmm.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. |cite| image:: https://joss.theoj.org/papers/10.21105/joss.02292/status.svg
   :target: https://doi.org/10.21105/joss.02292
   :alt: Cite our Paper
