Metadata-Version: 2.4
Name: pype-schema
Version: 0.7.0
Summary: Class hierarchy to represent configurations of process engineering systems.
Home-page: https://github.com/we3lab/pype-schema
Author: WE3 Lab
Author-email: fchapin@stanford.edu
Keywords: pype-schema
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Free for non-commercial use
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pint>=0.19.2
Requires-Dist: networkx>=2.8.5
Requires-Dist: pyvis>=0.3.0
Requires-Dist: matplotlib>=3.5.2
Requires-Dist: pandas>=1.4.0
Requires-Dist: numpy>=1.22.1
Requires-Dist: scipy>=1.8.0
Requires-Dist: epyt>=1.0.0
Provides-Extra: setup
Provides-Extra: test
Requires-Dist: black>=22.3.0; extra == "test"
Requires-Dist: flake8>=4.0.0; extra == "test"
Requires-Dist: codecov>=2.1.4; extra == "test"
Requires-Dist: pytest>=6.2.5; extra == "test"
Requires-Dist: pytest-cov>=3.0.0; extra == "test"
Requires-Dist: pytest-html>=3.1.1; extra == "test"
Provides-Extra: dev
Requires-Dist: black>=22.3.0; extra == "dev"
Requires-Dist: flake8>=4.0.0; extra == "dev"
Requires-Dist: codecov>=2.1.4; extra == "dev"
Requires-Dist: pytest>=6.2.5; extra == "dev"
Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
Requires-Dist: pytest-html>=3.1.1; extra == "dev"
Requires-Dist: tox>=3.24.5; extra == "dev"
Requires-Dist: Sphinx==7.0.1; extra == "dev"
Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "dev"
Provides-Extra: all
Requires-Dist: pint>=0.19.2; extra == "all"
Requires-Dist: networkx>=2.8.5; extra == "all"
Requires-Dist: pyvis>=0.3.0; extra == "all"
Requires-Dist: matplotlib>=3.5.2; extra == "all"
Requires-Dist: pandas>=1.4.0; extra == "all"
Requires-Dist: numpy>=1.22.1; extra == "all"
Requires-Dist: scipy>=1.8.0; extra == "all"
Requires-Dist: epyt>=1.0.0; extra == "all"
Requires-Dist: black>=22.3.0; extra == "all"
Requires-Dist: flake8>=4.0.0; extra == "all"
Requires-Dist: codecov>=2.1.4; extra == "all"
Requires-Dist: pytest>=6.2.5; extra == "all"
Requires-Dist: pytest-cov>=3.0.0; extra == "all"
Requires-Dist: pytest-html>=3.1.1; extra == "all"
Requires-Dist: tox>=3.24.5; extra == "all"
Requires-Dist: Sphinx==7.0.1; extra == "all"
Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "all"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

*********************************************
Python for Process Engineering Schema (PyPES)
*********************************************

.. image::
   https://github.com/we3lab/pype-schema/workflows/Build%20Main/badge.svg
   :height: 30
   :target: https://github.com/we3lab/pype-schema/actions
   :alt: Build Status

.. image::
   https://github.com/we3lab/pype-schema/workflows/Documentation/badge.svg
   :height: 30
   :target: https://we3lab.github.io/pype-schema
   :alt: Documentation

.. image::
   https://codecov.io/gh/we3lab/pype-schema/branch/main/graph/badge.svg
   :height: 30
   :target: https://codecov.io/gh/we3lab/pype-schema
   :alt: Code Coverage

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
===============

1. ``pip install -e .``

  This will install your package in editable mode.

2. ``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``.

3. ``docs/make html``

  This will generate an HTML version of the documentation which can be found
  at ``_build/html/index.html``.

4. ``flake8 pype_schema --count --verbose --show-source --statistics``

  This will lint the code and share all the style errors it finds.

5. ``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 <https://cife.stanford.edu/>`_ at Stanford University as a
a part of CIFE Seed Proposal 2023-02
`Formal proofs of safe operating limits at wastewater resource recovery facilities <https://cife.stanford.edu/formal-proofs-safe-operating-limits-wastewater-resource-recovery-facilities>`_.

- `LICENSE <https://github.com/we3lab/pype-schema/blob/main/LICENSE/>`_
- `CONTRIBUTING <https://github.com/we3lab/pype-schema/blob/main/CONTRIBUTING.rst/>`_
