WaterTAP

Create an open-source water treatment model library that is compatible with the IDAES Platform.
https://github.com/watertap-org/watertap

Category: Natural Resources
Sub Category: Water Supply and Quality

Keywords

idaes-pse idaesplus watertap

Keywords from Contributors

process-modeling chemical-engineering process-systems-engineering pse training energy-system battery renewable windows-7 foqus

Last synced: about 12 hours ago
JSON representation

Repository metadata

The WaterTAP development repository

README.md

WaterTAP

This is the WaterTAP development repository.

WaterTAP is developed as part of the National Alliance for Water Innovation project.

Build Status

Checks
Documentation Status
codecov
GitHub contributors
Merged PRs
Issue stats

Getting started

To quickly install and start using WaterTAP, head over to the Getting Started section of the documentation.

Graphical UI

The WaterTAP UI lets you configure and run flowsheets in a graphical user interface.
This UI has been renamed the Flowsheet Processor, with variants containing flowsheets for the WaterTAP, IDAES, and PrOMMiS projects.

  • One-click native installer for Windows and MacOS: Download
  • Source code installation (UNIX/Linux): Github

Tutorials

To run the WaterTAP tutorials online (no installation required), refer to this guide.

Documentation

The WaterTAP documentation is available online at https://watertap.readthedocs.io.

Developer Installation

If you want to clone the repository and work directly with the code, please
refer to the Getting Started for Developers section of the documentation.

Cite this work

To cite this work, please use the "Cite this repository" feature available on the right side of this repository page.

Funding Acknowledgements

This work is being conducted as part of the National Alliance for Water Innovation
(NAWI)
with support through the U.S. Department of Energy’s Advanced
Manufacturing Office
.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - name: "WaterTAP contributors"
title: "WaterTAP: An open-source water treatment model library"
url: "https://github.com/watertap-org/watertap"
license-url: "https://github.com/watertap-org/watertap/blob/main/LICENSE.md"
identifiers:
  - description: "WaterTAP 1.0 Release"
    type: url
    value: "https://edx.netl.doe.gov/dataset/watertap-1-0-release"
preferred-citation:
  type: software
  authors:
    - family-names: "Atia"
      given-names: "Adam"
    - family-names: "Holly"
      given-names: "Marcus"
    - family-names: "Knueven"
      given-names: "Bernard"
    - family-names: "Wang"
      given-names: "Chenyu"
    - family-names: "Amusat"
      given-names: "Oluwamayowa"
    - family-names: "Barber"
      given-names: "Hunter"
    - family-names: "Beattie"
      given-names: "Keith"
    - family-names: "Bi"
      given-names: "Xiangyu"
    - family-names: "Bianchi"
      given-names: "Ludovico"
    - family-names: "Binger"
      given-names: "Zachary"
    - family-names: "Dudchenko"
      given-names: "Alexander V"
    - family-names: "Garciadiego"
      given-names: "Alejandro"
    - family-names: "Gunter"
      given-names: "Dan"
    - family-names: "Lee"
      given-names: "Andrew"
    - family-names: "Panda"
      given-names: "Kinshuk"
    - family-names: "Pesce"
      given-names: "Michael"
    - family-names: "Sakhai"
      given-names: "Savannah"
    - family-names: "Shamlou"
      given-names: "Elmira"
    - family-names: "Sitterley"
      given-names: "Kurban A"
    - family-names: "Vecchiarelli"
      given-names: "Paul"
    - family-names: "Allu"
      given-names: "Srikanth"
    - family-names: "Hardikar"
      given-names: "Mukta"
    - family-names: "Tucker"
      given-names: "Carson"
    - family-names: "Bartholomew"
      given-names: "Timothy"
  title: "WaterTAP 1.0 Release"
  version: 1.0
  date-released: "2024-08-02"
  doi: "10.18141/2528074"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 2,543
Total Committers: 40
Avg Commits per committer: 63.575
Development Distribution Score (DDS): 0.877

Commits in past year: 74
Committers in past year: 18
Avg Commits per committer in past year: 4.111
Development Distribution Score (DDS) in past year: 0.649

Name Email Commits
adam-a-a a****a@k****m 314
Bernard Knueven B****n@n****v 277
Dan Gunter d****r@l****v 220
luohezhiming c****g@k****m 187
hunterbarber b****5@m****u 174
MarcusHolly 9****y 162
Ludovico Bianchi l****i@l****v 151
TimBartholomew t****w@n****v 134
Andrew Lee a****e@n****v 113
Kinshuk Panda k****a@n****v 112
arao53 a****o@k****m 92
kurbansitterley k****y@n****v 83
Austin Ladshaw l****p@o****v 80
lbibl x****i@g****m 73
agarciadiego 50
tarnold17 t****7@g****m 43
Gavin Wiggins 6****g 36
Ethan Young e****g@n****v 32
Keith Beattie k****e@l****v 29
avdudchenko 3****o 23
MichaelPesce 3****e 22
carson-tucker c****t@s****u 18
Allu, Srikanth a****s@o****v 14
OOAmusat 4****t 13
agarciadiego 4****o 12
ElmiraShamlou 1****u 11
Austin Ladshaw a****3@o****m 10
Zhuoran Zhang z****2@c****u 9
zacharybinger z****r@n****v 9
savannahsakhai 1****i 9
and 10 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 212
Total pull requests: 502
Average time to close issues: 3 months
Average time to close pull requests: about 1 month
Total issue authors: 27
Total pull request authors: 37
Average comments per issue: 2.03
Average comments per pull request: 2.65
Merged pull request: 398
Bot issues: 0
Bot pull requests: 0

Past year issues: 39
Past year pull requests: 99
Past year average time to close issues: about 2 months
Past year average time to close pull requests: about 1 month
Past year issue authors: 11
Past year pull request authors: 23
Past year average comments per issue: 1.69
Past year average comments per pull request: 1.94
Past year merged pull request: 67
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/watertap-org/watertap

Top Issue Authors

  • adam-a-a (72)
  • lbianchi-lbl (43)
  • hunterbarber (16)
  • bknueven (15)
  • MarcusHolly (12)
  • dangunter (6)
  • TimBartholomew (5)
  • wigging (5)
  • luohezhiming (4)
  • kurbansitterley (4)
  • arao53 (4)
  • zacharybinger (4)
  • OOAmusat (2)
  • veccp (2)
  • AARON683 (2)

Top Pull Request Authors

  • MarcusHolly (93)
  • bknueven (72)
  • lbianchi-lbl (62)
  • adam-a-a (45)
  • luohezhiming (30)
  • hunterbarber (22)
  • kurbansitterley (19)
  • avdudchenko (18)
  • ElmiraShamlou (15)
  • agarciadiego (13)
  • zacharybinger (12)
  • k1nshuk (11)
  • MichaelPesce (11)
  • savannahsakhai (10)
  • lbibl (9)

Top Issue Labels

  • Priority:Normal (138)
  • enhancement (62)
  • Priority:High (46)
  • bug (37)
  • documentation (32)
  • Priority:Low (18)
  • iedo (12)
  • property_model (12)
  • 1.0 (11)
  • master issue (10)
  • costing (9)
  • model dev team (8)
  • IDAES (8)
  • Backlog (7)
  • ui (7)
  • question (6)
  • nawi (6)
  • dependencies (6)
  • oli (5)
  • utility (4)
  • learning cohort (4)
  • fsapi (4)
  • software admin (4)
  • spring-cleaning (3)
  • jupyter (3)
  • Discussion (3)
  • Dec 2022 release (2)
  • chem team (2)
  • deprecation (2)
  • zo-model (2)

Top Pull Request Labels

  • Priority:Normal (303)
  • Priority:High (156)
  • 1.0 (46)
  • documentation (42)
  • iedo (38)
  • IDAES (22)
  • dependencies (17)
  • :cherries: Merge to rel (16)
  • oli (13)
  • costing (13)
  • enhancement (12)
  • ui (12)
  • software admin (9)
  • nawi (8)
  • Priority:Low (8)
  • property_model (8)
  • bugfix (7)
  • parameter-sweep (6)
  • analysis (6)
  • bug (5)
  • Backlog (5)
  • spring-cleaning (5)
  • model dev team (5)
  • jupyter (4)
  • utility (4)
  • WIP (3)
  • chem team (3)
  • deprecation (2)
  • dynamics (2)
  • PrOMMiS (2)

Package metadata

pypi.org: watertap

WaterTAP modeling library

  • Homepage: https://github.com/watertap-org/watertap
  • Documentation: https://watertap.readthedocs.io/
  • Licenses: BSD
  • Latest release: 1.3.0 (published 4 months ago)
  • Last Synced: 2025-07-29T18:37:14.362Z (1 day ago)
  • Versions: 43
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 6,391 Last month
  • Rankings:
    • Forks count: 6.011%
    • Dependent packages count: 10.002%
    • Stargazers count: 11.394%
    • Average: 12.542%
    • Downloads: 13.586%
    • Dependent repos count: 21.718%
  • Maintainers (2)

Dependencies

requirements-dev.txt pypi
  • black ==22.3.0
  • pre-commit *
setup.py pypi
  • SPECIAL_DEPENDENCIES_FOR_PRERELEASE ,
  • click *
  • fastjsonschema *
  • for *
  • h5py *
  • maintainers *
  • nbformat *
  • numpy *
  • primary *
  • pydantic *
  • pymongo >3
  • pyomo >=6.2
  • scipy *
  • the *
  • tutorial *
.github/workflows/checks.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v2 composite
  • conda-incubator/setup-miniconda v2 composite
  • supercharge/mongodb-github-action 3f91157600649d0002802978c8b6fb6ee659a2dd composite
.github/workflows/mpi4py-test.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite

Score: 17.617249837487588