PyPES

A class hierarchy designed to represent configurations of process engineering systems, such as wastewater treatment or desalination plants.
https://github.com/we3lab/pype-schema

Category: Natural Resources
Sub Category: Water Supply and Quality

Last synced: about 16 hours ago
JSON representation

Repository metadata

Class hierarchy to represent a wastewater treatment plant's configuration

• Host: GitHub
• URL: https://github.com/we3lab/pype-schema
• Owner: we3lab
• License: mit
• Created: 2022-07-07T01:11:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-12-01T15:47:55.000Z (about 1 month ago)
• Last Synced: 2025-12-09T04:21:55.474Z (about 1 month ago)
• Language: Python
• Size: 20.1 MB
• Stars: 7
• Watchers: 5
• Forks: 2
• Open Issues: 9
• Releases: 33
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Citation: CITATION.cff

README.rst

          .. image::
   https://raw.githubusercontent.com/we3lab/pype-schema/refs/heads/main/docs/_static/pypes-logo.png

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

.. image:: https://zenodo.org/badge/511340686.svg
  :height: 30
  :target: https://doi.org/10.5281/zenodo.17042020
  :alt: Zenodo DOI

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

- `LICENSE `_
- `CONTRIBUTING `_

        

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If this software has been useful in your research, we encourage you to cite it using the provided metadata."
authors:
  - family-names: "Chapin"
    given-names: "Fletcher T."
    orcid: "https://orcid.org/0000-0002-2165-7963"
  - family-names: "Liu"
    given-names: "Yin-Li"
    orcid: "https://orcid.org/0009-0004-9732-3371"
  - family-names: "Bolorinos"
    given-names: "Jose"
    orcid: "https://orcid.org/0000-0002-3741-5483"
  - family-names: "Wettermark"
    given-names: "Daly"
    orcid: "https://orcid.org/0000-0001-7151-2765"
  - family-names: "Rao"
    given-names: "Akshay K."
    orcid: "https://orcid.org/0000-0002-9054-476X"
  - family-names: "Mauter"
    given-names: "Meagan S."
    orcid: "https://orcid.org/0000-0002-4932-890X"
title: "Python for Process Engineering Schema (PyPES)"
version: 0.7.2
type: software
doi: 10.5281/zenodo.17042020
url: "https://github.com/we3lab/pype-schema"

---

Owner metadata

• Name: we3lab
• Login: we3lab
• Email:
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/33632663?v=4
• Repositories: 4
• Last ynced at: 2023-03-02T16:26:14.494Z
• Profile URL: https://github.com/we3lab

---

GitHub Events

Total

• Create event: 17
• Release event: 6
• Issues event: 9
• Delete event: 22
• Issue comment event: 11
• Push event: 111
• Pull request review event: 7
• Pull request review comment event: 4
• Pull request event: 12

Last Year

• Create event: 14
• Release event: 6
• Issues event: 9
• Delete event: 21
• Issue comment event: 10
• Push event: 105
• Pull request review event: 7
• Pull request review comment event: 4
• Pull request event: 11

---

Committers metadata

Last synced: 5 days ago

Name	Email	Commits
Fletcher Chapin	f****n@g****m	94
Jose Bolorinos	j****s@g****m	2
Daly Wettermark	1****w	2
LilyLiu0719	4****9	1

---

Issue and Pull Request metadata

Last synced: about 1 month ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/we3lab/pype-schema

---

---

---

Package metadata

• Total packages: 2
• Total downloads:
  • pypi: 31 last-month
• Total dependent packages: 0 (may contain duplicates)
• Total dependent repositories: 0 (may contain duplicates)
• Total versions: 44
• Total maintainers: 2

Score: 7.655390644826152