Metadata-Version: 2.4
Name: prommis
Version: 1.0.0
Keywords: IDAES,energy systems,chemical engineering,process modeling
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: idaes-pse>=2.12.0
Requires-Dist: pyomo>=6.9.5
Provides-Extra: watertap
Requires-Dist: watertap[reaktoro]>=1.7.0; extra == "watertap"
Provides-Extra: flowsheet-processor
Requires-Dist: idaes-flowsheet-processor>=0.3; extra == "flowsheet-processor"
Provides-Extra: ui
Requires-Dist: prommis[flowsheet-processor]; extra == "ui"
Requires-Dist: idaes-ui; extra == "ui"
Requires-Dist: idaes-connectivity; extra == "ui"
Provides-Extra: dev
Requires-Dist: prommis[ui,watertap]; extra == "dev"
Requires-Dist: black[jupyter]==26.3.1; extra == "dev"
Requires-Dist: pylint==2.17.7; extra == "dev"
Requires-Dist: astroid==2.15.8; extra == "dev"
Requires-Dist: pytest==7.*; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: jupyter-book==1.0.*; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: nbmake==1.4.6; extra == "dev"
Requires-Dist: sphinx_design==0.6.0; extra == "dev"
Dynamic: license-file

# PrOMMiS

This is the Process Optimization and Modeling for Minerals Sustainability (PROMMiS) development repository.

## Build Status

[![Documentation Status](https://readthedocs.org/projects/prommis/badge/?version=latest)](https://prommis.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/prommis/prommis/branch/main/graph/badge.svg)](https://codecov.io/gh/prommis/prommis)  
[![GitHub contributors](https://img.shields.io/github/contributors/prommis/prommis.svg)](https://github.com/prommis/prommis/graphs/contributors)  
[![Merged PRs](https://img.shields.io/github/issues-pr-closed-raw/prommis/prommis.svg?label=merged+PRs)](https://github.com/prommis/prommis/pulls?q=is:pr+is:merged)
![Open Issues](https://img.shields.io/github/issues/prommis/prommis)
![Closed Issues](https://img.shields.io/github/issues-closed/prommis/prommis)

## Getting started

Go to the [Getting Started](https://prommis.readthedocs.io/en/stable/getting_started.html) section of the documentation to quickly learn how to install and use PrOMMiS.

### Graphical UI

The **Flowsheet Processor** lets you configure and run flowsheets in a graphical user interface, including specific versions designed for the IDAES, WaterTAP, and PrOMMiS initiatives.

* One-click native installer for Windows and MacOS: [Download](https://prommis.github.io/idaes-flowsheet-processor-ui/docs/Download/prommis)
* Source code installation (UNIX/Linux): [Github](https://github.com/prommis/idaes-flowsheet-processor-ui)

## Documentation

The PrOMMiS documentation is available online at <https://prommis.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://prommis.readthedocs.io/en/stable/getting_started.html#for-prommis-developers) section of the documentation.

## Contact

For partnership opportunities with the PrOMMiS team, contact us at [prommis-support@lbl.gov](prommis-support@lbl.gov).

## 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 effort was funded by the U.S. Department of Energy’s Process Optimization and Modeling for Minerals Sustainability (PrOMMiS) Initiative, supported by the Department of Energy’s Hydrocarbons and Geothermal Energy Office.
