Welcome to the Python for Process Engineering Schema (PyPES) documentation!
Overview
Class Hierarchy
JSON Parsing
Miscellaneous
Python for Process Engineering Schema (PyPES)
A class hierarchy designed to represent configurations of process engineering systems, such as wastewater treatment or desalination plants.
Full documentation available at https://we3lab.github.io/pype-schema/.
Useful Commands
pip install -e .
This will install your package in editable mode.
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.
docs/make html
This will generate an HTML version of the documentation which can be found at
_build/html/index.html.
flake8 pype_schema --count --verbose --show-source --statistics
This will lint the code and share all the style errors it finds.
black pype_schema
This will reformat the code according to strict style guidelines.
Legal Documents
This work is supported by the National Alliance for Water Innovation (NAWI), funded by the U.S. Department of Energy, Energy Efficiency and Renewable Energy Office, Advanced Manufacturing Office under Funding Opportunity Announcement DE-FOA-0001905. The views expressed herein do not necessarily represent the views of the U.S. Department of Energy or the United States Government.
This work is also supported by the Center for Integrated Facility Engineering at Stanford University as a a part of CIFE Seed Proposal 2023-02 Formal proofs of safe operating limits at wastewater resource recovery facilities.