aguaclara

A Python package for designing and performing research on AguaClara water treatment plants.
https://github.com/AguaClara/aguaclara

Category: Natural Resources
Sub Category: Water Supply and Quality

Keywords

aguaclara python water-treatment

Last synced: about 12 hours ago
JSON representation

Repository metadata

An open-source Python package for designing and performing research on AguaClara water treatment plants.

Host: GitHub
URL: https://github.com/AguaClara/aguaclara
Owner: AguaClara
License: mit
Created: 2017-05-30T17:35:36.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-08-19T23:52:01.000Z (8 months ago)
Last Synced: 2025-04-20T08:37:53.050Z (7 days ago)
Topics: aguaclara, python, water-treatment
Language: Python
Homepage: https://aguaclara.github.io/aguaclara/
Size: 15 MB
Stars: 26
Watchers: 11
Forks: 13
Open Issues: 17
Releases: 55
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

`aguaclara`

aguaclara is a Python package developed by AguaClara Cornell and AguaClara Reach for designing and performing research on AguaClara water treatment plants. The package has several main functionalities:

DESIGN of AguaClara water treatment plant components
MODELING of physical, chemical, and hydraulic processes in water treatment
PLANNING of experimental setup for water treatment research
ANALYSIS of data collected by ProCoDA (process control and data acquisition tool)

Installing

The aguaclara package can be installed from Pypi by running the following command in the command line:

pip install aguaclara

To upgrade an existing installation, run

pip install aguaclara --upgrade

Using `aguaclara`

aguaclara's main functionalities come from several sub-packages.

Core: fundamental physical, chemical, and hydraulic functions and values
Design: modules for designing components of an AguaClara water treatment plant
Research: modules for process modeling, experimental design, and data analysis in AguaClara research

To use aguaclara's registry of scientific units (based on the Pint package), use from aguaclara.core.units import u. Any other function or value in a sub-package can be accessed by importing the package itself:

Example Usage: Design

import aguaclara as ac
from aguaclara.core.units import u

# Design a water treatment plant
plant = ac.Plant(
    q = 40 * u.L / u.s,
    cdc = ac.CDC(coag_type = 'pacl'),
    floc = ac.Flocculator(hl = 40 * u.cm),
    sed = ac.Sedimentor(temp = 20 * u.degC),
    filter = ac.Filter(q = 20 * u.L / u.s)
)

Example Usage: Core

# continued from Example Usage: Design

# Model physical, chemical, and hydraulic properties 
cdc = plant.cdc
coag_tube_reynolds_number = ac.re_pipe(
    FlowRate = cdc.coag_q_max,
    Diam = cdc.coag_tube_id,
    Nu = cdc.coag_nu(cdc.coag_stock_conc, cdc.coag_type)
)

Example Usage: Research

import aguaclara as ac
from aguaclara.core.units import u
import matplotlib.pyplot as plt

# Plan a research experiment
reactor = ac.Variable_C_Stock(
    Q_sys = 2 * u.mL / u.s, 
    C_sys = 1.4 * u.mg / u.L, 
    Q_stock = 0.01 * u.mL / u.s
)
C_stock_PACl = reactor.C_stock()

# Visualize and analyze ProCoDA data
ac.iplot_columns(
    path = "https://raw.githubusercontent.com/AguaClara/team_resources/master/Data/datalog%206-14-2018.xls", 
    columns = [3, 4], 
    x_axis = 0
)
plt.ylabel("Turbidity (NTU)")
plt.xlabel("Time (hr)")
plt.legend(("Influent", "Effluent"))

The package is still undergoing rapid development. As it becomes more stable, a user guide will be written with more detailed tutorials. At the moment, you can find some more examples in specific pages of the API reference.

Contributing

Bug reports, features requests, documentation updates, and any other enhancements are welcome! To suggest a change, make an issue in the aguaclara Github repository.

To contribute to the package as a developer, refer to the Developer Guide.

Owner metadata

Name: AguaClara at Cornell
Login: AguaClara
Email: [email protected]
Kind: organization
Description: This is the AguaClara Cornell Project Team, the research arm of the AguaClara consortium. Registered student organization of Cornell University.
Website: http://aguaclara.cornell.edu/
Location: Ithaca, NY
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/19206983?v=4
Repositories: 100
Last ynced at: 2024-05-21T02:19:46.613Z
Profile URL: https://github.com/AguaClara

GitHub Events

Total

Watch event: 2

Last Year

Watch event: 2

Committers metadata

Last synced: 7 days ago

Total Commits: 732
Total Committers: 33
Avg Commits per committer: 22.182
Development Distribution Score (DDS): 0.811

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name	Email	Commits
Oliver Leung	o**2@c**u	138
SageWS	j**4@e**u	99
ethan92429	e**r@g**m	87
karannewatia	k**8@c**u	66
fletchapin	f**n@g**m	64
Cynthia	c**7@c**u	59
HannahSi	h**9@c**u	59
Monroe Weber-Shirk	m**s@g**m	38
Aaron Yao-Smith	a**5@c**u	33
zoemaisel	3****7	22
Anthony Verghese	a**e@g**m	9
Elena Pertsalis	e**7@c**u	9
dtc66	d**6@c**u	6
William Pennock	w**8@c**u	5
fawnwong	f**g@l**m	5
Cynoc	c**7@c**u	4
Alice Zhao	4****0	3
Swastik Chaki	s**7@c**u	3
annabel48lin	4****n	3
ilee8	i**3@c**u	3
KevinSarmiento	3****o	2
juanchon998	j**8@c**u	2
Swastik Chaki	s**i@d**u	2
Swastik Chaki	s**i@d**u	2
vaishnavi-vinodh	6****h	1
prevosis	a**i@g**m	1
dependabot[bot]	d****]	1
Arianna Curillo	a**7@c**u	1
Swastik Chaki	s**i@d**u	1
Swastik Chaki	s**i@d**u	1
and 3 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 176
Total pull requests: 149
Average time to close issues: 7 months
Average time to close pull requests: 28 days
Total issue authors: 25
Total pull request authors: 19
Average comments per issue: 3.4
Average comments per pull request: 1.38
Merged pull request: 111
Bot issues: 0
Bot pull requests: 7

Past year issues: 1
Past year pull requests: 1
Past year average time to close issues: about 1 month
Past year average time to close pull requests: N/A
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 15.0
Past year average comments per pull request: 2.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/AguaClara/aguaclara

Top Issue Authors

monroews (51)
oliver-leung (27)
fletchapin (24)
HannahSi (13)
zoemaisel (12)
anthonyverghese (9)
eak24 (8)
WPennock (5)
juanchon998 (4)
CynthiaTChan (4)
DeelanChiu (3)
jillfoley19 (2)
annabel48lin (2)
ariannacurillo (1)
jillianwhiting (1)

Top Pull Request Authors

oliver-leung (40)
HannahSi (25)
eak24 (16)
vaishnavi-vinodh (12)
fletchapin (11)
monroews (10)
aaronyaosmith (7)
dependabot[bot] (7)
annabel48lin (4)
alicezha0 (4)
sc2267 (3)
marcin-sawczuk (2)
KevinSarmiento (2)
clare45 (1)
ariannacurillo (1)

Top Issue Labels

low (54)
bug (38)
feature (37)
aide_design (26)
research_it (20)
medium (19)
high (13)
package (9)

Top Pull Request Labels

feature (11)
dependencies (8)
aide_design (8)
high (4)
medium (3)
low (2)
package (2)
research_it (1)
bug (1)

Package metadata

Total packages: 3
Total downloads:
- pypi: 1,371 last-month
Total dependent packages: 0 (may contain duplicates)
Total dependent repositories: 2 (may contain duplicates)
Total versions: 143
Total maintainers: 2

proxy.golang.org: github.com/aguaclara/aguaclara

Homepage:
Documentation: https://pkg.go.dev/github.com/aguaclara/aguaclara#section-documentation
Licenses: mit
Latest release: v0.3.4 (published about 2 years ago)
Last Synced: 2025-04-25T14:05:31.410Z (1 day ago)
Versions: 49
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%

proxy.golang.org: github.com/AguaClara/aguaclara

Homepage:
Documentation: https://pkg.go.dev/github.com/AguaClara/aguaclara#section-documentation
Licenses: mit
Latest release: v0.3.4 (published about 2 years ago)
Last Synced: 2025-04-25T14:05:31.488Z (1 day ago)
Versions: 49
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%

pypi.org: aguaclara

An open-source Python package for designing and performing research on AguaClara water treatment plants.

Homepage: https://github.com/AguaClara/aguaclara
Documentation: https://aguaclara.github.io/aguaclara/
Licenses: MIT
Latest release: 0.3.4 (published about 2 years ago)
Last Synced: 2025-04-25T14:05:31.044Z (1 day ago)
Versions: 45
Dependent Packages: 0
Dependent Repositories: 2
Downloads: 1,371 Last month
Rankings:
- Dependent packages count: 7.303%
- Forks count: 9.892%
- Average: 11.477%
- Dependent repos count: 11.788%
- Downloads: 13.161%
- Stargazers count: 15.239%
Maintainers (2)
- aguaclara
- HannahSi

Dependencies

Pipfile pypi

Sphinx * develop
aguaclara * develop
atomicwrites >=1.0 develop
autopep8 * develop
codecov * develop
colorama * develop
coverage * develop
pylint * develop
pytest * develop
pytest-cov * develop
pytest-runner * develop
requests >=2.20.0 develop
rope * develop
sphinx_rtd_theme * develop
matplotlib *
onshape_client *
pandas *
pint *
scipy *
urllib3 *

Pipfile.lock pypi

aguaclara * develop
alabaster ==0.7.12 develop
astroid ==2.5.1 develop
atomicwrites ==1.4.0 develop
attrs ==20.3.0 develop
autopep8 ==1.5.6 develop
babel ==2.9.0 develop
certifi ==2020.12.5 develop
chardet ==4.0.0 develop
codecov ==2.1.11 develop
colorama ==0.4.4 develop
coverage ==5.5 develop
cycler ==0.10.0 develop
docutils ==0.16 develop
idna ==2.10 develop
imagesize ==1.2.0 develop
iniconfig ==1.1.1 develop
isort ==5.8.0 develop
jinja2 ==2.11.3 develop
kiwisolver ==1.3.1 develop
lazy-object-proxy ==1.5.2 develop
markupsafe ==1.1.1 develop
matplotlib ==3.3.4 develop
mccabe ==0.6.1 develop
nulltype ==2.3.1 develop
numpy ==1.20.1 develop
oauthlib ==3.1.0 develop
onshape-client ==1.6.3 develop
packaging ==20.9 develop
pandas ==1.2.3 develop
pillow ==8.1.2 develop
pint ==0.16.1 develop
pluggy ==0.13.1 develop
py ==1.10.0 develop
pycodestyle ==2.7.0 develop
pygments ==2.8.1 develop
pylint ==2.7.2 develop
pyparsing ==2.4.7 develop
pytest ==6.2.2 develop
pytest-cov ==2.11.1 develop
pytest-runner ==5.3.0 develop
python-dateutil ==2.8.1 develop
pytz ==2021.1 develop
requests ==2.25.1 develop
requests-oauthlib ==1.3.0 develop
rope ==0.18.0 develop
ruamel.yaml ==0.16.13 develop
ruamel.yaml.clib ==0.2.2 develop
scipy ==1.6.1 develop
six ==1.15.0 develop
snowballstemmer ==2.1.0 develop
sphinx ==3.5.3 develop
sphinx-rtd-theme ==0.5.1 develop
sphinxcontrib-applehelp ==1.0.2 develop
sphinxcontrib-devhelp ==1.0.2 develop
sphinxcontrib-htmlhelp ==1.0.3 develop
sphinxcontrib-jsmath ==1.0.1 develop
sphinxcontrib-qthelp ==1.0.3 develop
sphinxcontrib-serializinghtml ==1.1.4 develop
toml ==0.10.2 develop
urllib3 ==1.26.4 develop
wrapt ==1.12.1 develop
certifi ==2020.12.5
chardet ==4.0.0
cycler ==0.10.0
idna ==2.10
kiwisolver ==1.3.1
matplotlib ==3.3.4
nulltype ==2.3.1
numpy ==1.20.1
oauthlib ==3.1.0
onshape-client ==1.6.3
packaging ==20.9
pandas ==1.2.3
pillow ==8.1.2
pint ==0.16.1
pyparsing ==2.4.7
python-dateutil ==2.8.1
pytz ==2021.1
requests ==2.25.1
requests-oauthlib ==1.3.0
ruamel.yaml ==0.16.13
ruamel.yaml.clib ==0.2.2
scipy ==1.6.1
six ==1.15.0
urllib3 ==1.26.4

setup.py pypi

matplotlib *
onshape_client *
pandas *
pint *
scipy *
urllib3 *

.github/workflows/build.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
chabad360/htmlproofer master composite
codecov/codecov-action v3 composite

.github/workflows/docs.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
peaceiris/actions-gh-pages v3 composite

.github/workflows/publish.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
pypa/gh-action-pypi-publish master composite

Score: 14.483916687260713

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

aguaclara

Keywords

Repository metadata

README.md

`aguaclara`

Installing

Using `aguaclara`

Example Usage: Design

Example Usage: Core

Example Usage: Research

Contributing

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

proxy.golang.org: github.com/aguaclara/aguaclara

proxy.golang.org: github.com/AguaClara/aguaclara

pypi.org: aguaclara

Dependencies

aguaclara

Keywords

Repository metadata

README.md

aguaclara

Installing

Using aguaclara

Example Usage: Design

Example Usage: Core

Example Usage: Research

Contributing

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

proxy.golang.org: github.com/aguaclara/aguaclara

proxy.golang.org: github.com/AguaClara/aguaclara

pypi.org: aguaclara

Dependencies

`aguaclara`

Using `aguaclara`