Pyswmm

Happy 10th Anniversary, PySWMM! In celebration of this release and this milestone in this decade-long endeavor, we have introduced so much new functionality to the tool.

Added

- Step-Advance now leverages the `swmm_stride` entry point inside `EPA-SWMM` to give discrete control over model time-stepping [(481)](https://github.com/pyswmm/pyswmm/pull/481)
- New and more Pythonic ways to pull time series data from the Output files [(511)](https://github.com/pyswmm/pyswmm/pull/511)
- Simulation "State Manager" which is setup to throw an exception if the user tries to instantiate more than one `Simulation` Object at a time [(513)](https://github.com/pyswmm/pyswmm/pull/513)
- Token-based parameter modifiers for pre-simulation model changes. This makes this project easily suitable to embed into **optimization** with 100% coverage of the INP file for mutable parameters [(512)](https://github.com/pyswmm/pyswmm/pull/512).

Changed

- Major rewrite of LID and Most of the Documentation [(499)](https://github.com/pyswmm/pyswmm/pull/499).
- Added Deprecation Warning for internal class variables `Simulation._isOpen` and `Simulation._isStarted` [(513)](https://github.com/pyswmm/pyswmm/pull/513).

Removed

- `Simulation.initial_conditions()` and prescribed migration approach inside documentation` [(513)](https://github.com/pyswmm/pyswmm/pull/513).

This release introduced the ability to save a hot start file at any point during a running simulation (formally known as "Bread Crumbs") and select a different hot start file using the API before a new simulation starts.

Added

- Hotstart file Use/Save Features [(476)](https://github.com/pyswmm/pyswmm/pull/476).
- Added Deprecation warning for "Simulation.initial_conditions" [(446)](https://github.com/pyswmm/pyswmm/pull/446).



-----------------

(Older Changelog Format)

New Features
* added pip extras to enable easily installing pyswmm with different versions of swmm-python

Issues Closed
Bugs fixed

* [Issue 360](https://github.com/OpenWaterAnalytics/pyswmm/issues/360) - node hrt accessor fixed

Pull Requests Merged
* Unit test with OWA SWMM 5.1.15
* [PR 374](https://github.com/OpenWaterAnalytics/pyswmm/pull/374) - debug LID tutorial code
* [PR 377](https://github.com/OpenWaterAnalytics/pyswmm/pull/377) - updates to readme.md for pyswmm.org website
* [PR 393](https://github.com/OpenWaterAnalytics/pyswmm/pull/393) - updates to readme.md for pyswmm youtube channel
* [PR 392](https://github.com/OpenWaterAnalytics/pyswmm/pull/392) - overhaul pyswmm sphinx docs

New Feature

* [Issue 230](https://github.com/OpenWaterAnalytics/pyswmm/issues/230) - Pollutant treatment enhancements

Issues Closed

Bugs fixed

* [Issue 312](https://github.com/OpenWaterAnalytics/pyswmm/issues/312) - Pip install pyswmm does not install julian

In this release 1 issue was closed.

Pull Requests Merged

* [PR 313](https://github.com/OpenWaterAnalytics/pyswmm/pull/313) - v1.1.1, by [jennwuu](https://github.com/jennwuu)

In this release 1 pull request was closed.