-
Notifications
You must be signed in to change notification settings - Fork 184
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Addition of stormwater and wastewater capabilities in WNTR #437
Open
kaklise
wants to merge
77
commits into
USEPA:main
Choose a base branch
from
kaklise:swntr
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… and Link classes
… node and link type in G
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The following PR includes preliminary capabilities to analyze stormwater and wastewater systems in WNTR. This capability resides in the stormwater subpackage and is referred to as S-WNTR since it is intended to be used as a standalone package. A subset of WNTR classes/methods/functions are imported into the stormwater subpackage to avoid duplicating code where possible.
The capabilities leverage SWMM, pyswmm, and swmmio within a framework that facilitates the use of WNTR for resilience analysis of stormwater and wastewater systems. This update includes SWMM, pyswmm, and swmmio as optional dependencies of WNTR.
Note that unlike WNTR for drinking water systems, S-WNTR does not convert models to SI units. The SWMM INP file units are retained.
Basic usage
The user can
import wntr.stormwater as swntr
and then load a SWMM INP file into aStormWaterNetworkModel
object usingswn = swntr.network.StormWaterNetworkModel(inp_filename)
. The model is stored as a collection of Pandas DataFrames, which can be modified to change model properties and create scenarios for resilience analysis.Simulations are run using
sim = swntr.sim.SWMMSimulator(swn)
followed byresults = sim.run_sim()
. Simulation results are stored in pandas DataFrames for node, link, and subcatchment attributes.Additional capabilities
For more information, see stormwater.rst
Tests and documentation
Tests have been included in test_stormwater.py and documentation in stormwater.rst
Acknowledgement
By contributing to this software project, I acknowledge that I have reviewed the software quality assurance guidelines and that my contributions are submitted under the Revised BSD License.