pype-schema

Class hierarchy to represent a wastewater treatment plant's configuration

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

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Class hierarchy to represent a wastewater treatment plant's configuration

Basic Info
  • Host: GitHub
  • Owner: we3lab
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 20.1 MB
Statistics
  • Stars: 4
  • Watchers: 5
  • Forks: 1
  • Open Issues: 10
  • Releases: 0
Created about 4 years ago · Last pushed 11 months ago
Metadata Files
Readme Contributing License

README.rst

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

Owner

  • Name: we3lab
  • Login: we3lab
  • Kind: organization

GitHub Events

Total
  • Create event: 15
  • Release event: 6
  • Issues event: 8
  • Delete event: 22
  • Issue comment event: 10
  • Push event: 102
  • Pull request review event: 2
  • Pull request review comment event: 3
  • Pull request event: 10
Last Year
  • Create event: 15
  • Release event: 6
  • Issues event: 8
  • Delete event: 22
  • Issue comment event: 10
  • Push event: 102
  • Pull request review event: 2
  • Pull request review comment event: 3
  • Pull request event: 10

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 93
  • Total Committers: 4
  • Avg Commits per committer: 23.25
  • Development Distribution Score (DDS): 0.043
Past Year
  • Commits: 15
  • Committers: 3
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.133
Top Committers
Name Email Commits
Fletcher Chapin f****n@g****m 89
Jose Bolorinos j****s@g****m 2
LilyLiu0719 4****9 1
Daly Wettermark 1****w 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 23
  • Total pull requests: 42
  • Average time to close issues: 7 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 0.57
  • Average comments per pull request: 0.98
  • Merged pull requests: 37
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 14
  • Average time to close issues: 21 days
  • Average time to close pull requests: 3 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.93
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • fletchapin (11)
  • jbolorinos (7)
  • dalyw (4)
  • ThyanRevolter (1)
Pull Request Authors
  • fletchapin (32)
  • jbolorinos (5)
  • LilyLiu0719 (4)
  • dalyw (1)
Top Labels
Issue Labels
needs triage (17) enhancement (15) documentation (4) bug (4) good first issue (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 137 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 42
  • Total maintainers: 1
proxy.golang.org: github.com/we3lab/pype-schema
  • Versions: 33
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 11 months ago
pypi.org: pype-schema

Class hierarchy to represent configurations of process engineering systems.

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 137 Last month
Rankings
Dependent packages count: 9.8%
Average: 37.3%
Dependent repos count: 64.8%
Maintainers (1)
Last synced: 11 months ago