watertap

The WaterTAP development repository

https://github.com/watertap-org/watertap

Science Score: 54.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    8 of 40 committers (20.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.8%) to scientific vocabulary

Keywords

idaes-pse idaesplus watertap

Keywords from Contributors

chemical-engineering process-modeling process-systems-engineering pse nonlinear-programming transformation
Last synced: 6 months ago · JSON representation ·

Repository

The WaterTAP development repository

Basic Info
Statistics
  • Stars: 76
  • Watchers: 8
  • Forks: 77
  • Open Issues: 117
  • Releases: 28
Topics
idaes-pse idaesplus watertap
Created over 5 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Codeowners Copyright

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.

Owner

  • Name: watertap-org
  • Login: watertap-org
  • Kind: organization

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"

GitHub Events

Total
  • Create event: 12
  • Release event: 6
  • Issues event: 60
  • Watch event: 15
  • Issue comment event: 228
  • Push event: 94
  • Gollum event: 7
  • Pull request review comment event: 429
  • Pull request review event: 531
  • Pull request event: 132
  • Fork event: 15
Last Year
  • Create event: 12
  • Release event: 6
  • Issues event: 60
  • Watch event: 15
  • Issue comment event: 228
  • Push event: 94
  • Gollum event: 7
  • Pull request review comment event: 429
  • Pull request review event: 531
  • Pull request event: 132
  • Fork event: 15

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 2,547
  • Total Committers: 40
  • Avg Commits per committer: 63.675
  • Development Distribution Score (DDS): 0.876
Past Year
  • Commits: 78
  • Committers: 18
  • Avg Commits per committer: 4.333
  • Development Distribution Score (DDS): 0.654
Top Committers
Name Email Commits
adam-a-a a****a@k****m 316
Bernard Knueven B****n@n****v 277
Dan Gunter d****r@l****v 220
luohezhiming c****g@k****m 188
hunterbarber b****5@m****u 174
MarcusHolly 9****y 163
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 (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 218
  • Total pull requests: 751
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 27
  • Total pull request authors: 38
  • Average comments per issue: 1.73
  • Average comments per pull request: 2.41
  • Merged pull requests: 545
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 46
  • Pull requests: 181
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 1 month
  • Issue authors: 11
  • Pull request authors: 22
  • Average comments per issue: 0.48
  • Average comments per pull request: 1.41
  • Merged pull requests: 105
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • adam-a-a (80)
  • lbianchi-lbl (44)
  • hunterbarber (14)
  • bknueven (14)
  • MarcusHolly (12)
  • dangunter (7)
  • TimBartholomew (5)
  • kurbansitterley (4)
  • wigging (4)
  • zacharybinger (4)
  • arao53 (4)
  • luohezhiming (4)
  • AARON683 (2)
  • fahim831 (2)
  • agarciadiego (2)
Pull Request Authors
  • MarcusHolly (159)
  • bknueven (92)
  • lbianchi-lbl (88)
  • adam-a-a (72)
  • luohezhiming (39)
  • kurbansitterley (35)
  • hunterbarber (34)
  • ElmiraShamlou (27)
  • avdudchenko (25)
  • zacharybinger (21)
  • agarciadiego (17)
  • savannahsakhai (16)
  • MichaelPesce (15)
  • lbibl (13)
  • k1nshuk (11)
Top Labels
Issue Labels
Priority:Normal (111) enhancement (57) Priority:High (39) bug (38) documentation (28) Priority:Low (15) iedo (11) property_model (10) 1.0 (10) IDAES (8) ui (7) master issue (7) costing (7) model dev team (7) nawi (6) question (5) dependencies (5) Backlog (5) utility (4) fsapi (4) oli (4) software admin (4) spring-cleaning (3) jupyter (3) Discussion (3) Dec 2022 release (2) chem team (2) analysis (2) deprecation (2) learning cohort (2)
Pull Request Labels
Priority:Normal (400) Priority:High (212) 1.0 (81) documentation (55) iedo (42) IDAES (33) :cherries: Merge to rel (27) oli (20) dependencies (20) enhancement (17) ui (16) Priority:Low (15) costing (15) property_model (11) nawi (11) spring-cleaning (10) analysis (9) software admin (8) Backlog (7) bug (7) parameter-sweep (7) bugfix (6) model dev team (6) jupyter (5) WIP (5) PrOMMiS (5) utility (5) deprecation (4) fsapi (4) dynamics (3)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 5,823 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 1
  • Total versions: 44
  • Total maintainers: 2
pypi.org: watertap

WaterTAP modeling library

  • Versions: 44
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 5,823 Last month
Rankings
Forks count: 6.0%
Dependent packages count: 10.0%
Stargazers count: 11.4%
Average: 12.5%
Downloads: 13.6%
Dependent repos count: 21.7%
Maintainers (2)
Last synced: 6 months ago

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