Metadata-Version: 2.1
Name: watertap
Version: 0.12.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.8
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.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: idaes-pse<2.5.0rc0,>=2.4.0
Requires-Dist: pyomo>=6.6.1
Requires-Dist: pyyaml
Requires-Dist: pymongo>3
Requires-Dist: fastjsonschema
Requires-Dist: click
Requires-Dist: h5py
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: pydantic<3,>=2
Requires-Dist: numpy
Requires-Dist: importlib-resources
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: json-schema-for-humans; extra == "testing"
Requires-Dist: mongomock; extra == "testing"
Requires-Dist: pandas; extra == "testing"
Requires-Dist: nbmake!=1.5.1; extra == "testing"
Requires-Dist: nbconvert; 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"
Provides-Extra: dev
Requires-Dist: nbsphinx; extra == "dev"
Requires-Dist: jinja2<3.1.0; extra == "dev"
Requires-Dist: Sphinx==7.1.*; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: urllib3<2; extra == "dev"
Requires-Dist: linkify-it-py; extra == "dev"
Requires-Dist: json-schema-for-humans; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: mongomock; extra == "dev"
Requires-Dist: nbmake!=1.5.1; extra == "dev"

# 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.

If you wish to use the **WaterTAP UI**, you can [download and install](https://watertap-org.github.io) it from this page: https://watertap-org.github.io.

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, use the "Cite this repository" feature available on the right side of this repository page or use the reference text given below.

> WaterTAP contributors. WaterTAP: An open-source water treatment model library. Version 0.6. Sponsored by California Energy Commission, National Alliance for Water Innovation, and USDOE. Available at https://github.com/watertap-org/watertap.

## 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).
