prommis

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

Last synced: about 20 hours ago
JSON representation

Repository metadata

Process Optimization and Modeling for Minerals Sustainability

• Host: GitHub
• URL: https://github.com/prommis/prommis
• Owner: prommis
• License: other
• Created: 2023-12-11T16:54:13.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-05-09T19:31:47.000Z (2 days ago)
• Last Synced: 2024-05-11T06:07:09.590Z (about 23 hours ago)
• Language: Python
• Homepage: https://prommis.readthedocs.io
• Size: 1.19 MB
• Stars: 4
• Watchers: 9
• Forks: 18
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

README

        
# 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 metadata

• Name: PrOMMiS
• Login: prommis
• Email:
• Kind: organization
• Description: Process Optimization and Modeling for Minerals Sustainability
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/124107808?v=4
• Repositories: 1
• Last ynced at: 2023-12-11T19:25:37.863Z
• Profile URL: https://github.com/prommis

---

GitHub Events

Total

• Create event: 6
• Release event: 3
• Issues event: 25
• Watch event: 5
• Issue comment event: 141
• Push event: 45
• Gollum event: 1
• Pull request review comment event: 207
• Pull request review event: 239
• Pull request event: 78
• Fork event: 18

Last Year

• Create event: 6
• Fork event: 18
• Gollum event: 1
• Issue comment event: 172
• Issues event: 28
• Pull request event: 93
• Pull request review comment event: 307
• Pull request review event: 335
• Push event: 50
• Release event: 3
• Watch event: 5

---

Committers metadata

Last synced: 2 days ago

Name	Email	Commits
MarcusHolly	m****y@k****m	38
Ludovico Bianchi	l****i@l****v	31
Arkoprabho Dasgupta	a****7@g****m	25
Andrew Lee	a****e@n****v	11
MarcusHolly	9****y	9
Brandon Paul	8****4	7
Dan Gunter	d****r@l****v	5
Jinliang Ma	j****a@n****v	4
ArkoprabhoDasgupta	1****a	3
agarciadiego	4****o	2
ChrisLaliwala	1****a	2
Akintomiwa Ojo	1****o	2
agarciadiego	a****g@k****m	1
Arkoprabho Dasgupta	a****5@m****u	1
mollydougher	1****r	1
Keith Beattie	k****e@l****v	1

Committer domains:

• lbl.gov: 3
• netl.doe.gov: 2
• keylogic.com: 2
• mail.wvu.edu: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

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

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 71 last-month
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 4
• Total maintainers: 2

---

Dependencies

Score: 10.241101993736118