pype-schema

Class hierarchy to represent configurations of process engineering systems.


Keywords
pype-schema
Licenses
AFL-3.0/NCGL-UK-2.0
Install
pip install pype-schema==0.5.0

Documentation

Python for Process Engineering Schema (PyPES)

Build Status Documentation Code Coverage

A class hierarchy designed to represent configurations of process engineering systems, such as wastewater treatment or desalination plants.

Useful Commands

  1. pip install -e .
This will install your package in editable mode.
  1. pytest pype_schema/tests --cov=pype_schema --cov-report=html
Produces an HTML test coverage report for the entire project which can be found at htmlcov/index.html.
  1. docs/make html
This will generate an HTML version of the documentation which can be found at _build/html/index.html.
  1. flake8 pype_schema --count --verbose --show-source --statistics
This will lint the code and share all the style errors it finds.
  1. black pype_schema
This will reformat the code according to strict style guidelines.

Legal Documents