Process Optimization and Modeling for Minerals Sustainability

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).

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 running any of these commands, ensure the prommis-dev Conda environment has been activated:

conda activate prommis-dev

isort src/prommis

black .

pylint prommis

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.

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

From the docs/ subdirectory:

jupyter-book build .

From the docs/ subdirectory:

pytest --nbmake -m "solution" .