Skip to main content

No project description provided

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prommis-0.4.0.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

prommis-0.4.0-py3-none-any.whl (224.5 kB view details)

Uploaded Python 3

File details

Details for the file prommis-0.4.0.tar.gz.

File metadata

  • Download URL: prommis-0.4.0.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for prommis-0.4.0.tar.gz
Algorithm Hash digest
SHA256 fbf7a6a446041d11f6af05f97af412170a69c4bba9977642cdd984357a13bdb3
MD5 79adc1bfe05189c8f1374183281d1614
BLAKE2b-256 69af642fa24ca35f70db9b0f29e1c72106de72f55bbaecd114873034c7950b98

See more details on using hashes here.

File details

Details for the file prommis-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: prommis-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 224.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for prommis-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02bfc97e33e22ec28fdf94d540cf371beb5173c1b7e811bcabeddc55787e1a0c
MD5 a94859627fb23dc2eb0999d494e7c864
BLAKE2b-256 8ad25ace8c71029059cc24b8a186506cdadb61cc98668d2a514b5484fce4f844

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page