A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

PARETO

An Optimization Framework for Produced Water Management and Beneficial Reuse.
https://github.com/project-pareto/project-pareto

Category: Natural Resources
Sub Category: Water Supply and Quality

Keywords

idaesplus pse

Keywords from Contributors

process-modeling chemical-engineering process-systems-engineering idaes-pse foqus

Last synced: about 19 hours ago
JSON representation

Repository metadata

An Optimization Framework for Produced Water Management and Beneficial Reuse

README.md

project-pareto

An Optimization Framework for Produced Water Management and Beneficial Reuse

Project Status

Checks
codecov
Documentation Status
Contributors
Merged PRs
Issue stats
Downloads

Getting started

For complete installation instructions, including developer install instructions, see the Getting Started page of the PARETO online documentation.

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:

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.

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.

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.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - name: "PARETO contributors"
title: "Produced Water Application for Beneficial Reuse, Environmental Impact and Treatment Optimization (PARETO)"
url: "https://github.com/project-pareto/project-pareto"
license-url: "https://github.com/project-pareto/project-pareto/blob/main/LICENSE.md"
identifiers:
  - description: "OSTI archive of PARETO releases."
    type: url
    value: "https://www.osti.gov/search/semantic:pareto"
preferred-citation:
  type: article
  authors:
    - family-names: "Drouven"
      given-names: "Markus G"
    - family-names: "Caldéron"
      given-names: "Andrés J"
    - family-names: "Zamarripa"
      given-names: "Miguel A"
    - family-names: "Beattie"
      given-names: "Keith"
  title: "PARETO: An open-source produced water optimization framework"
  journal: "Optimization and Engineering"
  publisher: "Springer Science and Business Media LLC"
  volume: 24
  number: 3
  pages: 2229–2249
  year: 2022
  doi: "http://dx.doi.org/10.1007/s11081-022-09773-w"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 681
Total Committers: 25
Avg Commits per committer: 27.24
Development Distribution Score (DDS): 0.771

Commits in past year: 119
Committers in past year: 10
Avg Commits per committer in past year: 11.9
Development Distribution Score (DDS) in past year: 0.639

Name Email Commits
melody-shellman m****n@o****m 156
tarnold17 t****7@g****m 70
Ludovico Bianchi l****i@l****v 67
Andres Calderon a****9@h****m 59
Andres Calderon c****a@a****e 44
drouvenm m****n@n****v 43
NienkeWagenaar 5****r 42
MichaelPesce m****e@g****m 42
Naresh Susarla s****n@a****e 29
Naresh Susarla n****a@n****v 24
Yash Puranik y****k@a****m 21
Keith Beattie k****e@l****v 17
ElmiraShamlou e****u@k****m 15
Ruud Wagemaker r****w@O****m 13
Miguel Zamarripa m****z@n****v 9
Philip Tominac p****c@k****m 8
JavalVyas2000 7****0 7
bduffieldKL b****d@k****m 3
[email protected] z****m@a****e 3
Sakshi 7****9 2
Huidae Cho g****u@g****m 2
Arsh Bhatia 1****1 2
Dan Gunter d****r@l****v 1
Sourabh Kumar Choudhary 6****t 1
Tominapa 6****a 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 112
Total pull requests: 203
Average time to close issues: 5 months
Average time to close pull requests: 28 days
Total issue authors: 12
Total pull request authors: 19
Average comments per issue: 1.54
Average comments per pull request: 1.74
Merged pull request: 168
Bot issues: 0
Bot pull requests: 0

Past year issues: 13
Past year pull requests: 24
Past year average time to close issues: 4 months
Past year average time to close pull requests: 20 days
Past year issue authors: 5
Past year pull request authors: 7
Past year average comments per issue: 1.08
Past year average comments per pull request: 1.13
Past year merged pull request: 21
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/project-pareto/project-pareto

Top Issue Authors

  • drouvenm (28)
  • melody-shellman (22)
  • lbianchi-lbl (19)
  • tarnold17 (19)
  • Andresj89 (10)
  • ksbeattie (4)
  • NienkeWagenaar (2)
  • dangunter (2)
  • pulsipher (2)
  • Tominapa (2)
  • apd-lyang (1)
  • MAZamarripa (1)

Top Pull Request Authors

  • Andresj89 (40)
  • lbianchi-lbl (33)
  • drouvenm (31)
  • tarnold17 (21)
  • melody-shellman (16)
  • ksbeattie (14)
  • MAZamarripa (12)
  • JavalVyas2000 (9)
  • ElmiraShamlou (5)
  • HuidaeCho (4)
  • bduffieldKL (3)
  • Sakshi21299 (3)
  • arshb11 (3)
  • NienkeWagenaar (2)
  • nareshsusarla (2)

Top Issue Labels

  • Priority:Normal (59)
  • Priority:High (41)
  • enhancement (35)
  • bug (16)
  • backlog (13)
  • Priority:Low (12)
  • Jupyter Notebook (6)
  • documentation (5)
  • tests (4)
  • operational model (3)
  • Treatment (3)
  • UI (1)
  • pre-commit (1)

Top Pull Request Labels

  • Priority:High (96)
  • Priority:Normal (93)
  • enhancement (72)
  • bug (22)
  • documentation (8)
  • tests (6)
  • binary files changes (5)
  • backlog (2)
  • operational model (1)

Dependencies

.github/workflows/checks.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite
docs/Dockerfile docker
  • sphinxdoc/sphinx-latexpdf latest build
requirements-dev.txt pypi
  • addheader * development
  • black ==22.3.0 development
  • myst-parser * development
  • nbsphinx * development
  • pre-commit ==2.16. development
  • pytest ==6.2. development
  • pytest-cov * development
  • sphinx * development
  • sphinx_rtd_theme * development
setup.py pypi
  • for *
  • idaes-pse *
  • kaleido *
  • openpyxl *
  • pandas ==1.2.
  • plotly ==5.11.0
  • pyomo >=6.2
  • requests *

Score: 7.090076835776092