Metadata-Version: 2.4
Name: watertap
Version: 1.5.0
Summary: WaterTAP modeling library
Home-page: https://github.com/watertap-org/watertap
Author: NAWI team
License: BSD
Keywords: water systems,chemical engineering,process modeling,filtration,desalination,nawi
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: idaes-pse>=2.10.0
Requires-Dist: pyomo>=6.6.1
Requires-Dist: watertap-solvers
Requires-Dist: pyyaml
Requires-Dist: parameter-sweep>=0.1.0
Requires-Dist: numpy
Requires-Dist: pint<0.25
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: pandas; extra == "testing"
Requires-Dist: nbmake!=1.5.1; extra == "testing"
Requires-Dist: nbconvert; extra == "testing"
Requires-Dist: idaes-flowsheet-processor>=0.1.dev4; extra == "testing"
Provides-Extra: notebooks
Requires-Dist: jupyter; extra == "notebooks"
Requires-Dist: ipykernel; extra == "notebooks"
Provides-Extra: oli-api
Requires-Dist: requests; extra == "oli-api"
Requires-Dist: cryptography; extra == "oli-api"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# WaterTAP

This is the WaterTAP development repository.

WaterTAP is developed as part of the [National Alliance for Water Innovation](https://nawihub.org/) project.

## Build Status

[![Checks](https://github.com/watertap-org/watertap/actions/workflows/checks.yml/badge.svg)](https://github.com/watertap-org/watertap/actions/workflows/checks.yml)
[![Documentation Status](https://readthedocs.org/projects/watertap/badge/?version=latest)](https://watertap.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/watertap-org/watertap/branch/main/graph/badge.svg)](https://codecov.io/gh/watertap-org/watertap)  
[![GitHub contributors](https://img.shields.io/github/contributors/watertap-org/watertap.svg)](https://github.com/watertap-org/watertap/graphs/contributors)  
[![Merged PRs](https://img.shields.io/github/issues-pr-closed-raw/watertap-org/watertap.svg?label=merged+PRs)](https://github.com/watertap-org/watertap/pulls?q=is:pr+is:merged)  
[![Issue stats](http://isitmaintained.com/badge/resolution/watertap-org/watertap.svg)](http://isitmaintained.com/project/watertap-org/watertap)

## Getting started

To quickly install and start using WaterTAP, head over to the [Getting Started](https://watertap.readthedocs.io/en/stable/getting_started.html) 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](https://prommis.github.io/idaes-flowsheet-processor-ui/docs/Download/watertap)
* Source code installation (UNIX/Linux): [Github](https://github.com/prommis/idaes-flowsheet-processor-ui)

### Tutorials
To run the WaterTAP tutorials online (no installation required), refer to [this guide](https://watertap.readthedocs.io/en/stable/how_to_guides/notebooks.html#online-using-binder-org).

## 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](https://watertap.readthedocs.io/en/stable/getting_started.html#for-watertap-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)](https://www.nawihub.org/) with support through the U.S. Department of Energy’s [Advanced
Manufacturing Office](https://www.energy.gov/eere/amo/advanced-manufacturing-office).
