*********************************************
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 <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/>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/we3lab/pype-schema",
"name": "pype-schema",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pype-schema",
"author": "WE3 Lab",
"author_email": "fchapin@stanford.edu",
"download_url": "https://files.pythonhosted.org/packages/03/59/33edce45510d1280d1ce50322343a304db3bc86bb91caac479b6a033d258/pype-schema-0.6.0.tar.gz",
"platform": null,
"description": "*********************************************\nPython for Process Engineering Schema (PyPES)\n*********************************************\n\n.. image::\n https://github.com/we3lab/pype-schema/workflows/Build%20Main/badge.svg\n :height: 30\n :target: https://github.com/we3lab/pype-schema/actions\n :alt: Build Status\n\n.. image::\n https://github.com/we3lab/pype-schema/workflows/Documentation/badge.svg\n :height: 30\n :target: https://we3lab.github.io/pype-schema\n :alt: Documentation\n\n.. image::\n https://codecov.io/gh/we3lab/pype-schema/branch/main/graph/badge.svg\n :height: 30\n :target: https://codecov.io/gh/we3lab/pype-schema\n :alt: Code Coverage\n\nA class hierarchy designed to represent configurations of process engineering systems, such as wastewater treatment or desalination plants.\n\nUseful Commands\n===============\n\n1. ``pip install -e .``\n\n This will install your package in editable mode.\n\n2. ``pytest pype_schema/tests --cov=pype_schema --cov-report=html``\n\n Produces an HTML test coverage report for the entire project which can\n be found at ``htmlcov/index.html``.\n\n3. ``docs/make html``\n\n This will generate an HTML version of the documentation which can be found\n at ``_build/html/index.html``.\n\n4. ``flake8 pype_schema --count --verbose --show-source --statistics``\n\n This will lint the code and share all the style errors it finds.\n\n5. ``black pype_schema``\n\n This will reformat the code according to strict style guidelines.\n\nLegal Documents\n===============\n\nThis work was funded by the `Center for Integrated Facility Engineering <https://cife.stanford.edu/>`_ at Stanford University as a\na part of CIFE Seed Proposal 2023-02\n`Formal proofs of safe operating limits at wastewater resource recovery facilities <https://cife.stanford.edu/formal-proofs-safe-operating-limits-wastewater-resource-recovery-facilities>`_.\n\n- `LICENSE <https://github.com/we3lab/pype-schema/blob/main/LICENSE/>`_\n- `CONTRIBUTING <https://github.com/we3lab/pype-schema/blob/main/CONTRIBUTING.rst/>`_\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Class hierarchy to represent configurations of process engineering systems.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/we3lab/pype-schema"
},
"split_keywords": [
"pype-schema"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d6ae2224e31b625fcf423bbde1327035274e05de7fd2fb697e031664525cde07",
"md5": "41241c91fe5d1110faaa267b92bf3b9f",
"sha256": "aadfde0a245fd046f2053c27699d39a2ce5daa8d700adadf04a43bb71e85199a"
},
"downloads": -1,
"filename": "pype_schema-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "41241c91fe5d1110faaa267b92bf3b9f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 56317,
"upload_time": "2025-01-29T03:59:57",
"upload_time_iso_8601": "2025-01-29T03:59:57.411702Z",
"url": "https://files.pythonhosted.org/packages/d6/ae/2224e31b625fcf423bbde1327035274e05de7fd2fb697e031664525cde07/pype_schema-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "035933edce45510d1280d1ce50322343a304db3bc86bb91caac479b6a033d258",
"md5": "d15ba7b4005c38794ff50e5ca5d279ab",
"sha256": "60a49a113daad9c2495b989f335f348eff71fde73350d7f43dc77ed82e99b436"
},
"downloads": -1,
"filename": "pype-schema-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "d15ba7b4005c38794ff50e5ca5d279ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 403464,
"upload_time": "2025-01-29T03:59:59",
"upload_time_iso_8601": "2025-01-29T03:59:59.531862Z",
"url": "https://files.pythonhosted.org/packages/03/59/33edce45510d1280d1ce50322343a304db3bc86bb91caac479b6a033d258/pype-schema-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 03:59:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "we3lab",
"github_project": "pype-schema",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pype-schema"
}
JSON
