https://github.com/we3lab/pype-schema

Class hierarchy to represent a wastewater treatment plant's configuration
https://github.com/we3lab/pype-schema

Last synced: 3 months ago
JSON representation

Class hierarchy to represent a wastewater treatment plant's configuration

• Host: GitHub
• URL: https://github.com/we3lab/pype-schema
• Owner: we3lab
• License: other
• Created: 2022-07-07T01:11:00.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T04:20:33.000Z (6 months ago)
• Last Synced: 2024-05-22T19:03:32.409Z (6 months ago)
• Language: Python
• Size: 4.17 MB
• Stars: 4
• Watchers: 5
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - PyPES - A class hierarchy designed to represent configurations of process engineering systems, such as wastewater treatment or desalination plants. (Natural Resources / Water Supply and Quality)

README

        
*********************************************

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.

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 was funded 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 `_