Releases: pyswmm/pyswmm
v2.1.0
What's Changed
- added ctx mgr warning by @timothy-holmes in #530
- Dev code formatter by @timothy-holmes in #534
- Updating CI Runner System by @bemcdonnell in #590
- Fix typo in README.md (Vidoes → Videos) by @polyedr in #587
- Updates to CI Workflow by @bemcdonnell in #591
- Add 6 new smoke tests for Simulation and Output API by @polyedr in #588
- Fix missing value at end index issue by @michaeltryby in #592
- Cleaned dependency setup by @bemcdonnell in #594
- Stage release of pyswmm-v2.1.0 by @bemcdonnell in #595
New Contributors
- @timothy-holmes made their first contribution in #530
- @polyedr made their first contribution in #587
Full Changelog: v2.0.1...v2.1.0
Contributors
Assets 4
v2.0.1
Forgot to issue this release to GitHub (this is from a few months ago). This is already on PyPI
- Fixes object id lookup where object does not exist.
- updates to CI
v2.0.0
PySWMM-v2.0 is out!
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_strideentry point insideEPA-SWMMto give discrete control over model time-stepping (#481) - New and more Pythonic ways to pull time series data from the Output files (#511)
- Simulation "State Manager" which is setup to throw an exception if the user tries to instantiate more than one
SimulationObject at a time (#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).
Changed
- Major rewrite of LID and Most of the Documentation (#499).
- Added Deprecation Warning for internal class variables
Simulation._isOpenandSimulation._isStarted(#513).
Removed
Simulation.initial_conditions()and prescribed migration approach inside documentation` (#513).
v1.5.1
PySWMM-v1.5.1!!!
Many updates to the documentation and a nice link to our new Swag Store!
Get yourself a Hoodie and a coffee cup to weather this cold season (OR the cool sunglasses if you're South of the Equator enjoying the sun). All proceeds go toward the costs of the services required to maintain PySWMM and its family projects. "This is my GOOD side" and Don't you forget it!
Release Info
Patch requirements.txt with packaging
This release introduces the new features for using a different hot start file before starting your simulation and saving a new hotstart file during a running simulation at any point in time. It's so simple to use!!!
with Simulation("input_file.inp") as sim:
# To use a hot start file different from the one declared in the INP,
# call the following method before starting your simulation.
sim.use_hotstart("path_to_hot_start_to_use.hsf")
for ind, step in enumerate(sim):
if ind == 25: # at 25th simulation iteration step...
# during the simulation.. save a hot start with this method
sim.save_hotstart("path_to_hotstart_file.hsf")v1.5.0
PySWMM-v1.5.0!!!
Many updates to the documentation and a nice link to our new Swag Store!
Get yourself a Hoodie and a coffee cup to weather this cold season (OR the cool sunglasses if you're South of the Equator enjoying the sun). All proceeds go toward the costs of the services required to maintain PySWMM and its family projects. "This is my GOOD side" and Don't you forget it!
Release Info
This release introduces the new features for using a different hot start file before starting your simulation and saving a new hotstart file during a running simulation at any point in time. It's so simple to use!!!
with Simulation("input_file.inp") as sim:
# To use a hot start file different from the one declared in the INP,
# call the following method before starting your simulation.
sim.use_hotstart("path_to_hot_start_to_use.hsf")
for ind, step in enumerate(sim):
if ind == 25: # at 25th simulation iteration step...
# during the simulation.. save a hot start with this method
sim.save_hotstart("path_to_hotstart_file.hsf")v1.4.0
v1.3.0
Version 1.3.0 (2023/01/24)
Issues Closed
Bugs fixed
- Issue 360 - node hrt accessor fixed
Pull Requests Merged
v1.2.0
🚀🚨 pyswmm v.1.2.0 🚨🚀
Huge shoutout to @bemason and @karosc for their amazing work in this release 🙇🏼. Kudos to @jennwuu and @bemcdonnell for their persistent effort in maintaining pyswmm 🫶🏽.
Version 1.2.0 is our best version of pyswmm yet. In this release, we have added the feature for updating pollutants during a simulation. This feature unlocks a new avenue of water quality modeling in SWMM. We are no longer restricted to the default pollutant models in SWMM. We can now represent almost any pollutant model in SWMM via Python 🥳.
Furthermore, this feature extends pollutant modeling to Links as well. This feature would let us model water quality dynamics like sediment resuspension in channels. We are excited to see all the amazing things the community will do with this new version of pyswmm 😁.
We have also improved the robustness of pyswmm and addressed a few 🐛 in this release.