Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

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

prommis

Process Optimization and Modeling for Minerals Sustainability.
https://github.com/prommis/prommis

Category: Industrial Ecology
Sub Category: Circular Economy and Waste

Keywords

idaesplus

Keywords from Contributors

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

Last synced: about 20 hours ago
JSON representation

Repository metadata

Process Optimization and Modeling for Minerals Sustainability

README.md

prommis

Process Optimization and Modeling for Minerals Sustainability

Getting started (for PrOMMiS contributors)

Unless otherwise noted, these commands assume that the working directory is the root of the local clone of this repository (i.e. the directory containing this README file).

Installation

conda create --name prommis-dev --yes python=3.11
conda activate prommis-dev
git clone https://github.com/prommis/prommis && cd prommis
pip install -r requirements-dev.txt

Before committing

Before running any of these commands, ensure the prommis-dev Conda environment has been activated:

conda activate prommis-dev

Sort import statements

isort src/prommis

Formatting code

black .

Running linter (Pylint)

pylint prommis

Running spell checker (Typos)

typos

Note: if the typos executable is not found, it can be installed by running conda install --yes -c conda-forge typos after activating the prommis-dev Conda environment.

Running tests

pytest                          # run the complete test suite
pytest -k test_my_flowsheet.py  # run only test defined in the file named test_my_flowsheet.py

Building documentation

From the docs/ subdirectory:

jupyter-book build .

Testing (executing) notebooks

From the docs/ subdirectory:

pytest --nbmake -m "solution" .

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 191
Total Committers: 16
Avg Commits per committer: 11.938
Development Distribution Score (DDS): 0.707

Commits in past year: 57
Committers in past year: 14
Avg Commits per committer in past year: 4.071
Development Distribution Score (DDS) in past year: 0.684

Name Email Commits
MarcusHolly m****y@k****m 56
Ludovico Bianchi l****i@l****v 46
Arkoprabho Dasgupta a****7@g****m 29
Brandon Paul 8****4 14
Andrew Lee a****e@n****v 12
Dan Gunter d****r@l****v 6
Jinliang Ma j****a@n****v 6
Keith Beattie k****e@l****v 5
Akintomiwa Ojo 1****o 4
mollydougher 1****r 3
agarciadiego 4****o 3
Astrid 8****0 2
ChrisLaliwala 1****a 2
Jason Yao 1****o 1
Michael Bynum 2****m 1
Arkoprabho Dasgupta a****5@m****u 1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 50
Total pull requests: 121
Average time to close issues: 3 months
Average time to close pull requests: about 1 month
Total issue authors: 9
Total pull request authors: 15
Average comments per issue: 0.84
Average comments per pull request: 3.29
Merged pull request: 88
Bot issues: 0
Bot pull requests: 0

Past year issues: 29
Past year pull requests: 65
Past year average time to close issues: 3 months
Past year average time to close pull requests: about 1 month
Past year issue authors: 8
Past year pull request authors: 15
Past year average comments per issue: 0.66
Past year average comments per pull request: 3.32
Past year merged pull request: 41
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

  • lbianchi-lbl (15)
  • bpaul4 (14)
  • MarcusHolly (8)
  • dangunter (3)
  • dallan-keylogic (3)
  • michaelbynum (3)
  • ksbeattie (2)
  • Agfritz (1)
  • ArkoprabhoDasgupta (1)

Top Pull Request Authors

  • lbianchi-lbl (26)
  • MarcusHolly (19)
  • bpaul4 (17)
  • ksbeattie (10)
  • ChrisLaliwala (10)
  • ArkoprabhoDasgupta (9)
  • mollydougher (6)
  • Akintomiwaojo (5)
  • Lingyan90 (4)
  • andrewlee94 (4)
  • agarciadiego (3)
  • jinliangma (3)
  • dangunter (3)
  • jas-yao (1)
  • michaelbynum (1)

Top Issue Labels

  • Priority:Normal (39)
  • Priority:High (7)
  • documentation (6)
  • Priority:Low (2)
  • WaterTAP (2)
  • enhancement (2)
  • IDAES (1)
  • Priority:Would be nice (1)
  • Discussion (1)
  • bug (1)
  • pylint (1)
  • code-quality (1)

Top Pull Request Labels

  • Priority:Normal (78)
  • Priority:High (38)
  • WaterTAP (14)
  • IDAES (7)
  • documentation (7)
  • enhancement (7)
  • CMI (2)
  • tutorials (2)
  • bug (1)
  • costing (1)
  • Priority:Low (1)

Package metadata

pypi.org: prommis

  • Homepage:
  • Documentation: https://prommis.readthedocs.io/
  • Licenses: BSD License
  • Latest release: 0.7.0 (published 26 days ago)
  • Last Synced: 2025-04-25T14:03:09.232Z (2 days ago)
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 716 Last month
  • Rankings:
    • Dependent packages count: 10.151%
    • Average: 38.561%
    • Dependent repos count: 66.971%
  • Maintainers (2)

Dependencies

.github/actions/install/action.yml actions
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2.3.0 composite
.github/workflows/core.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • prommis/prommis/.github/actions/install main composite
pyproject.toml pypi
  • idaes-pse >= 2.3.0rc1
  • pyomo >= 6.7.0
requirements-dev.txt pypi
  • astroid ==2.15.8 development
  • black ==23.11.0 development
  • isort * development
  • jupyter-book ==0.15. development
  • nbmake ==1.4.6 development
  • pylint ==2.17.7 development
  • pytest ==7. development

Score: 12.904406352777418