Data

Tools

Indexes

Applications

Experiments

Open Source Science

wntr

An EPANET compatible python package to simulate and analyze water distribution networks under disaster scenarios.

https://github.com/usepa/wntr

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    19 of 62 committers (30.6%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary

Keywords

modeling ord python simulation water

Keywords from Contributors

mathematical-programming modeling-language nonlinear-programming quality-control snl-applications
Last synced: 6 months ago · JSON representation

Repository

An EPANET compatible python package to simulate and analyze water distribution networks under disaster scenarios.

Basic Info
  • Host: GitHub
  • Owner: USEPA
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 70.3 MB
Statistics
  • Stars: 378
  • Watchers: 39
  • Forks: 208
  • Open Issues: 37
  • Releases: 29
Topics
modeling ord python simulation water
Created over 9 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License

README.md


GitHub CI Coverage Status Documentation Status

The Water Network Tool for Resilience (WNTR) is a Python package designed to simulate and analyze resilience of water distribution networks. The software includes capability to:

  • Generate water network models
  • Modify network structure and operations
  • Add disruptive events including pipe leaks
  • Add response/repair strategies
  • Simulate pressure dependent demand and demand-driven hydraulics
  • Simulate water quality
  • Evaluate resilience
  • Visualize results

For more information, go to https://usepa.github.io/WNTR/

Installation

The latest release of WNTR can be installed from PyPI or Anaconda using one of the following commands in a command line or PowerShell prompt.

  • PyPI version Downloads

pip install wntr

  • Anaconda version downloads

conda install -c conda-forge wntr

See installation instructions for more details.

Citing WNTR

To cite WNTR, use one of the following references:

  • Klise, K.A., Hart, D.B., Bynum, M., Hogge, J., Haxton, T., Murray, R., Burkhardt, J. (2020). Water Network Tool for Resilience (WNTR) User Manual: Version 0.2.3. U.S. EPA Office of Research and Development, Washington, DC, EPA/600/R-20/185, 82p.

  • Klise, K.A., Murray, R., Haxton, T. (2018). An overview of the Water Network Tool for Resilience (WNTR), In Proceedings of the 1st International WDSA/CCWI Joint Conference, Kingston, Ontario, Canada, July 23-25, 075, 8p.

  • Klise, K.A., Bynum, M., Moriarty, D., Murray, R. (2017). A software framework for assessing the resilience of drinking water systems to disasters with an example earthquake case study, Environmental Modelling and Software, 95, 420-431, doi: 10.1016/j.envsoft.2017.06.022

License

WNTR is released under the Revised BSD license. See LICENSE.md for more details.

Organization

Directories * wntr - Python package * documentation - User manual * examples - Examples and network files

Contact

  • Katherine Klise, Sandia National Laboratories, kaklise@sandia.gov
  • Terra Haxton, US Environmental Protection Agency, haxton.terra@epa.gov
  • Regan Murray, US Environmental Protection Agency, murray.regan@epa.gov

EPA Disclaimer

The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity , confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.

Sandia Funding Statement

Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy's National Nuclear Security Administration under contract DE-NA-0003525.

Owner

  • Name: U.S. Environmental Protection Agency
  • Login: USEPA
  • Kind: organization
  • Location: United States of America

GitHub Events

Total
  • Create event: 14
  • Release event: 8
  • Issues event: 58
  • Watch event: 57
  • Delete event: 4
  • Member event: 1
  • Issue comment event: 158
  • Push event: 53
  • Pull request review comment event: 12
  • Pull request event: 87
  • Pull request review event: 28
  • Fork event: 26
Last Year
  • Create event: 14
  • Release event: 8
  • Issues event: 58
  • Watch event: 57
  • Delete event: 4
  • Member event: 1
  • Issue comment event: 158
  • Push event: 53
  • Pull request review comment event: 12
  • Pull request event: 87
  • Pull request review event: 28
  • Fork event: 26

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 2,991
  • Total Committers: 62
  • Avg Commits per committer: 48.242
  • Development Distribution Score (DDS): 0.605
Past Year
  • Commits: 196
  • Committers: 11
  • Avg Commits per committer: 17.818
  • Development Distribution Score (DDS): 0.316
Top Committers
Name Email Commits
kaklise k****e@s****v 1,181
Michael Bynum m****m 783
dbhart d****t@s****v 473
Wendy Dushanin 7****n 134
kbonney k****8@g****m 100
jhogge 5****e 47
Arpan Seth s****a@p****u 45
Thi t****n@g****m 32
Terra Haxton t****n 24
Santiago s****o@g****m 20
Daniel Villa 3****a 17
Joerg Rings m****l@r****e 9
Josh j****h@j****k 9
dmmoria d****a@s****v 9
Joi Chu-Ketterer 4****t 8
Regan Murray m****n@e****v 8
Carl Laird c****d@C****l 8
Michael Bynum m****m@p****u 7
santiagoropb s****b@g****m 6
GalPerelman p****r@g****m 5
Stephen Frechette s****e@c****u 5
angusmcb 5****b 4
Michael Bynum m****m@p****u 4
Michael Bynum b****m@B****l 4
Michael Bynum b****m@c****u 3
Michael Bynum m****m@p****u 3
Timothy Van Daele T****e@d****e 2
Patrick Hassett h****k@e****v 2
Carl Laird c****d@p****u 2
Buhari Shehu 4****S 2
and 32 more...
Committer Domains (Top 20 + Academic)
sandia.gov: 7 epa.gov: 4 purdue.edu: 1 rings.de: 1 joshkirk.co.uk: 1 pal-nat186-131-161.itap.purdue.edu: 1 che-143-7.dhcp.ecn.purdue.edu: 1 pal-nat186-138-215.itap.purdue.edu: 1 che-143-6.dhcp.ecn.purdue.edu: 1 pal-nat186-131-125.itap.purdue.edu: 1 dewatergroep.be: 1 pal-nat184-072-013.itap.purdue.edu: 1 hulo.ai: 1 cornell.edu: 1 pal-nat186-133-12.itap.purdue.edu: 1 pal-nat186-132-24.itap.purdue.edu: 1 pal-nat186-131-14.itap.purdue.edu: 1 zog.mozmail.com: 1 tu-darmstadt.de: 1 pal-nat186-141-228.itap.purdue.edu: 1 pal-nat186-134-148.itap.purdue.edu: 1 pal-nat186-135-57.itap.purdue.edu: 1 pal-nat186-136-159.itap.purdue.edu: 1 pal-nat186-137-223.itap.purdue.edu: 1 pal-nat186-137-38.itap.purdue.edu: 1 pal-nat186-139-125.itap.purdue.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 273
  • Total pull requests: 293
  • Average time to close issues: 4 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 153
  • Total pull request authors: 35
  • Average comments per issue: 3.29
  • Average comments per pull request: 1.11
  • Merged pull requests: 218
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 38
  • Pull requests: 91
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 14 days
  • Issue authors: 25
  • Pull request authors: 10
  • Average comments per issue: 1.42
  • Average comments per pull request: 1.46
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • angusmcb (12)
  • tyjchen (8)
  • henryco123 (6)
  • pshassett (6)
  • michaelbynum (6)
  • kalebsm (5)
  • DanielaBS1 (5)
  • uthmankareem (5)
  • YanisaMadmay (5)
  • dionikolop (5)
  • jeongsoo0908 (4)
  • mi-les (4)
  • emmaliulu (4)
  • chocolate-771 (4)
  • kbonney (4)
Pull Request Authors
  • kaklise (120)
  • kbonney (66)
  • dbhart (33)
  • angusmcb (22)
  • michaelbynum (20)
  • wDushanin (10)
  • Thaulino (3)
  • jckett (3)
  • BuhariS (3)
  • jhogge (3)
  • jrings (3)
  • mi-les (2)
  • pshassett (2)
  • dependabot[bot] (2)
  • seanotoole03 (2)
Top Labels
Issue Labels
support (34) enhancement (23) bug (18) installation (8) epanet (4) question (2) documentation (2) dependencies (2)
Pull Request Labels
dependencies (2) installation (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 13,689 last-month
  • Total docker downloads: 9
  • Total dependent packages: 6
    (may contain duplicates)
  • Total dependent repositories: 22
    (may contain duplicates)
  • Total versions: 35
  • Total maintainers: 1
pypi.org: wntr

Water Network Tool for Resilience

  • Versions: 26
  • Dependent Packages: 6
  • Dependent Repositories: 19
  • Downloads: 13,689 Last month
  • Docker Downloads: 9
Rankings
Dependent packages count: 1.6%
Dependent repos count: 3.4%
Docker downloads count: 3.5%
Forks count: 3.9%
Stargazers count: 3.9%
Average: 3.9%
Downloads: 7.2%
Maintainers (1)
kaklise
Last synced: 6 months ago
conda-forge.org: wntr
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 3
Rankings
Forks count: 14.4%
Dependent repos count: 17.9%
Stargazers count: 24.7%
Average: 27.1%
Dependent packages count: 51.5%
Last synced: 6 months ago

Dependencies

.github/workflows/build_tests.yml actions
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • actions/upload-artifact v2 composite
.github/workflows/quick_check.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/cibuildwheel v2.11.1 composite
  • pypa/gh-action-pypi-publish release/v1 composite
requirements.txt pypi
  • coverage *
  • folium *
  • geopandas *
  • ipykernel *
  • matplotlib *
  • nbconvert *
  • nbformat *
  • networkx *
  • numpy *
  • openpyxl *
  • pandas *
  • plotly <=5.11.0
  • pytest *
  • rtree *
  • scipy *
  • sphinx_rtd_theme *
  • utm *
.github/workflows/build_deploy_pages.yml actions
  • actions/checkout v3 composite
  • actions/configure-pages v3 composite
  • actions/deploy-pages v1 composite
  • actions/setup-python v2 composite
  • actions/upload-pages-artifact v1 composite
documentation/environment.yml pypi
pyproject.toml pypi
setup.py pypi