prommis
Process Optimization and Modeling for Minerals Sustainability
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
5 of 17 committers (29.4%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.8%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Process Optimization and Modeling for Minerals Sustainability
Basic Info
- Host: GitHub
- Owner: prommis
- License: other
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://prommis.readthedocs.io
- Size: 3.01 MB
Statistics
- Stars: 13
- Watchers: 9
- Forks: 36
- Open Issues: 25
- Releases: 12
Topics
Metadata Files
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
sh
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:
sh
conda activate prommis-dev
Sort import statements
sh
isort src/prommis
Formatting code
sh
black .
Running linter (Pylint)
sh
pylint prommis
Running spell checker (Typos)
sh
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
sh
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:
sh
jupyter-book build .
Testing (executing) notebooks
From the docs/ subdirectory:
sh
pytest --nbmake -m "solution" .
Owner
- Name: PrOMMiS
- Login: prommis
- Kind: organization
- Repositories: 1
- Profile: https://github.com/prommis
Process Optimization and Modeling for Minerals Sustainability
GitHub Events
Total
- Create event: 9
- Release event: 5
- Issues event: 31
- Watch event: 2
- Issue comment event: 196
- Push event: 70
- Pull request review comment event: 586
- Pull request event: 80
- Pull request review event: 525
- Fork event: 14
Last Year
- Create event: 9
- Release event: 5
- Issues event: 31
- Watch event: 2
- Issue comment event: 197
- Push event: 70
- Pull request review comment event: 586
- Pull request event: 80
- Pull request review event: 525
- Fork event: 14
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| MarcusHolly | m****y@k****m | 59 |
| Ludovico Bianchi | l****i@l****v | 48 |
| Arkoprabho Dasgupta | a****7@g****m | 32 |
| Brandon Paul | 8****4 | 17 |
| Andrew Lee | a****e@n****v | 12 |
| Keith Beattie | k****e@l****v | 7 |
| Jinliang Ma | j****a@n****v | 7 |
| Dan Gunter | d****r@l****v | 7 |
| mollydougher | 1****r | 4 |
| ChrisLaliwala | 1****a | 4 |
| Akintomiwa Ojo | 1****o | 4 |
| agarciadiego | 4****o | 3 |
| Astrid | 8****0 | 2 |
| Arkoprabho Dasgupta | a****5@m****u | 1 |
| Sufi Kaur | s****r@l****v | 1 |
| Jason Yao | 1****o | 1 |
| Michael Bynum | 2****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 48
- Total pull requests: 208
- Average time to close issues: 3 months
- Average time to close pull requests: about 1 month
- Total issue authors: 11
- Total pull request authors: 16
- Average comments per issue: 1.0
- Average comments per pull request: 3.33
- Merged pull requests: 134
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 22
- Pull requests: 93
- Average time to close issues: 26 days
- Average time to close pull requests: about 1 month
- Issue authors: 9
- Pull request authors: 15
- Average comments per issue: 1.32
- Average comments per pull request: 2.41
- Merged pull requests: 52
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- lbianchi-lbl (13)
- bpaul4 (13)
- MarcusHolly (7)
- dangunter (3)
- michaelbynum (3)
- ksbeattie (2)
- dnkey0202 (2)
- dallan-keylogic (2)
- adam-a-a (1)
- Agfritz (1)
- ArkoprabhoDasgupta (1)
Pull Request Authors
- lbianchi-lbl (34)
- MarcusHolly (31)
- bpaul4 (31)
- ArkoprabhoDasgupta (20)
- ChrisLaliwala (15)
- mollydougher (15)
- ksbeattie (12)
- Akintomiwaojo (10)
- jinliangma (8)
- Lingyan90 (7)
- dangunter (7)
- andrewlee94 (6)
- agarciadiego (5)
- jas-yao (3)
- michaelbynum (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 150 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 14
- Total maintainers: 2
pypi.org: prommis
- Documentation: https://prommis.readthedocs.io/
- License: BSD License
-
Latest release: 0.8.0
published 6 months ago
Rankings
Maintainers (2)
Dependencies
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2.3.0 composite
- actions/checkout v4 composite
- actions/setup-python v4 composite
- prommis/prommis/.github/actions/install main composite
- idaes-pse >= 2.3.0rc1
- pyomo >= 6.7.0
- 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