Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/project-pareto/project-pareto
An Optimization Framework for Produced Water Management and Beneficial Reuse
https://github.com/project-pareto/project-pareto
pse
Last synced: about 1 month ago
JSON representation
An Optimization Framework for Produced Water Management and Beneficial Reuse
- Host: GitHub
- URL: https://github.com/project-pareto/project-pareto
- Owner: project-pareto
- License: other
- Created: 2021-06-08T17:18:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T17:47:51.000Z (2 months ago)
- Last Synced: 2024-08-06T15:33:34.157Z (about 1 month ago)
- Topics: pse
- Language: Python
- Homepage: https://pareto.readthedocs.io
- Size: 29.8 MB
- Stars: 17
- Watchers: 4
- Forks: 28
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- open-sustainable-technology - PARETO - An Optimization Framework for Produced Water Management and Beneficial Reuse. (Natural Resources / Water Supply and Quality)
README
# project-pareto
An Optimization Framework for Produced Water Management and Beneficial Reuse
## Project Status
[](https://github.com/project-pareto/project-pareto/actions/workflows/checks.yml)
[](https://codecov.io/gh/project-pareto/project-pareto)
[](https://pareto.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/project-pareto/project-pareto/contributors)
[](https://github.com/project-pareto/project-pareto/pulls?q=is:pr+is:merged)
[](http://isitmaintained.com/project/project-pareto/project-pareto)
[](https://pepy.tech/project/project-pareto)
## Getting started
For complete installation instructions, including developer install instructions, see the [Getting Started](https://pareto.readthedocs.io/en/latest/getting_started/index.html) page of the [PARETO online documentation](https://pareto.readthedocs.io).
### Quickstart (user install)
The recommended way to install Pareto is to use a dedicated Conda environment.
To install the latest stable release of PARETO, create and activate the Conda environment, then install PARETO using `pip`:
```sh
conda create --yes -n pareto-env python=3.9
conda activate pareto-env
pip install project-pareto
idaes get-extensions --verbose
```
## Resources for PARETO contributors
See the "For developers" pages in the [PARETO GitHub Wiki](https://github.com/project-pareto/project-pareto/wiki).
## How to Cite PARETO software
If you make use of PARETO software in your work, please cite the following article:
```
@article{PARETO_article,
author = {Drouven, Markus G. and Caldéron, Andres J. and Zamarripa, Miguel A. and Beattie, Keith},
title = {PARETO: An open-source produced water optimization framework},
journal = {Optimization and Engineering},
year = {2023},
volume = {24},
number = {3},
pages = {2229–2249},
doi = {https://doi.org/10.1007/s11081-022-09773-w},
}
```
You can also cite the latest release of PARETO software (currently 0.9.0) as follows:
```
@misc{PARETO_090,
author = {Shellman, Melody and Arnold, Travis and Bianchi, Ludovico and Shamlou, Elmira and Susarla, Naresh and Tominac, Philip and Pesce, Michael and Poon, Sarah and Beattie, Keith and Zamarripa, Miguel and Gunter, Dan and Drouven, Markus},
title = {PARETO 0.9.0 Release},
month = {November},
year = {2023},
note = {https://edx.netl.doe.gov/dataset/pareto-0-9-0-release}
}
```
Citation information for previous versions of PARETO software may be found on [EDX](https://edx.netl.doe.gov/group/pareto).
## Funding Acknowledgement
This work was conducted as part of the Produced Water Optimization Initiative, “Project PARETO”,
with support through the Natural Gas & Oil Program within the U.S. Department of Energy’s Office of
Fossil Energy and Carbon Management (FECM). For more information please see
[www.project-pareto.org](http://www.project-pareto.org/).