Description:
prommis 0.4.0
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" .
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
