project-pareto

An Optimization Framework for Produced Water Management and Beneficial Reuse

https://github.com/project-pareto/project-pareto

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    3 of 25 committers (12.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary

Keywords

idaesplus pse
Last synced: 6 months ago · JSON representation ·

Repository

An Optimization Framework for Produced Water Management and Beneficial Reuse

Basic Info
Statistics
  • Stars: 19
  • Watchers: 3
  • Forks: 32
  • Open Issues: 30
  • Releases: 18
Topics
idaesplus pse
Created over 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

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:

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.

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.

Owner

  • Name: project-pareto
  • Login: project-pareto
  • Kind: organization

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"

GitHub Events

Total
  • Create event: 3
  • Release event: 2
  • Issues event: 8
  • Watch event: 2
  • Issue comment event: 21
  • Push event: 8
  • Pull request review event: 8
  • Pull request event: 14
  • Fork event: 4
Last Year
  • Create event: 3
  • Release event: 2
  • Issues event: 8
  • Watch event: 2
  • Issue comment event: 21
  • Push event: 8
  • Pull request review event: 8
  • Pull request event: 14
  • Fork event: 4

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 681
  • Total Committers: 25
  • Avg Commits per committer: 27.24
  • Development Distribution Score (DDS): 0.771
Past Year
  • Commits: 52
  • Committers: 5
  • Avg Commits per committer: 10.4
  • Development Distribution Score (DDS): 0.212
Top Committers
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
Miguel.Zamarripa-Perez@netl.doe.gov 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 (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 83
  • Total pull requests: 151
  • Average time to close issues: 6 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 12
  • Total pull request authors: 20
  • Average comments per issue: 1.55
  • Average comments per pull request: 1.86
  • Merged pull requests: 123
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 14
  • Average time to close issues: 24 days
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 5
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.57
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • melody-shellman (20)
  • tarnold17 (17)
  • drouvenm (15)
  • lbianchi-lbl (13)
  • Andresj89 (6)
  • ksbeattie (2)
  • dangunter (2)
  • pulsipher (2)
  • Tominapa (2)
  • apd-lyang (1)
  • NienkeWagenaar (1)
  • MAZamarripa (1)
Pull Request Authors
  • tarnold17 (33)
  • lbianchi-lbl (25)
  • Andresj89 (22)
  • JavalVyas2000 (18)
  • drouvenm (18)
  • ksbeattie (16)
  • melody-shellman (13)
  • ElmiraShamlou (9)
  • HuidaeCho (7)
  • MAZamarripa (6)
  • arshb11 (6)
  • Sakshi21299 (5)
  • MichaelPesce (2)
  • dangunter (2)
  • bduffieldKL (2)
Top Labels
Issue Labels
Priority:Normal (39) Priority:High (21) enhancement (20) Priority:Low (12) backlog (10) bug (9) Jupyter Notebook (6) tests (3) documentation (3) operational model (3) Treatment (2) UI (1) pre-commit (1)
Pull Request Labels
Priority:Normal (84) Priority:High (81) enhancement (40) bug (12) binary files changes (10) documentation (5) tests (3) backlog (2) operational model (1) Priority:Low (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 *