# 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" .
```
Raw data
{
"_id": null,
"home_page": null,
"name": "prommis",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "IDAES, energy systems, chemical engineering, process modeling",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/32/55/da2f754e0d8235256f039e0f12d02e8be7a924f46c190d29d295ac7199f9/prommis-0.5.0.tar.gz",
"platform": null,
"description": "# prommis\nProcess Optimization and Modeling for Minerals Sustainability\n\n## Getting started (for PrOMMiS contributors)\n\nUnless 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).\n\n### Installation\n\n```sh\nconda create --name prommis-dev --yes python=3.11\nconda activate prommis-dev\ngit clone https://github.com/prommis/prommis && cd prommis\npip install -r requirements-dev.txt\n```\n\n### Before committing\n\nBefore running any of these commands, ensure the `prommis-dev` Conda environment has been activated:\n\n```sh\nconda activate prommis-dev\n```\n\n#### Sort import statements\n\n```sh\nisort src/prommis\n```\n\n#### Formatting code\n\n```sh\nblack .\n```\n\n#### Running linter (Pylint)\n\n```sh\npylint prommis\n```\n\n#### Running spell checker (Typos)\n\n```sh\ntypos\n```\n\nNote: 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.\n\n#### Running tests\n\n```sh\npytest # run the complete test suite\npytest -k test_my_flowsheet.py # run only test defined in the file named test_my_flowsheet.py\n```\n\n#### Building documentation\n\nFrom the `docs/` subdirectory:\n\n```sh\njupyter-book build .\n```\n\n#### Testing (executing) notebooks\n\nFrom the `docs/` subdirectory:\n\n```sh\npytest --nbmake -m \"solution\" .\n```\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.5.0",
"project_urls": null,
"split_keywords": [
"idaes",
" energy systems",
" chemical engineering",
" process modeling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b6abc92e8f24a80001ca8c7d5c5f9532afe052a9c066a96d5d5efce643d167a",
"md5": "6323c5083603ccd7b7cc022545424d5c",
"sha256": "0e5c7db93d91115ace866e2b42de0d304a08b005bdadc1905fca3b4548d28bc0"
},
"downloads": -1,
"filename": "prommis-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6323c5083603ccd7b7cc022545424d5c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 273849,
"upload_time": "2024-11-02T05:32:25",
"upload_time_iso_8601": "2024-11-02T05:32:25.708908Z",
"url": "https://files.pythonhosted.org/packages/2b/6a/bc92e8f24a80001ca8c7d5c5f9532afe052a9c066a96d5d5efce643d167a/prommis-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3255da2f754e0d8235256f039e0f12d02e8be7a924f46c190d29d295ac7199f9",
"md5": "82645a4bddfae72743b0cdda1c6bfa3c",
"sha256": "b4fec44b7becfab4afe1383746cbdde6471367d07508697a9aba10b3a2df080c"
},
"downloads": -1,
"filename": "prommis-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "82645a4bddfae72743b0cdda1c6bfa3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1059627,
"upload_time": "2024-11-02T05:32:27",
"upload_time_iso_8601": "2024-11-02T05:32:27.776828Z",
"url": "https://files.pythonhosted.org/packages/32/55/da2f754e0d8235256f039e0f12d02e8be7a924f46c190d29d295ac7199f9/prommis-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 05:32:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "prommis"
}
JSON