aguaclara

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

Keywords

aguaclara python water-treatment

Last synced: 2 days ago
JSON representation

Acceptance Criteria

• Revelant topics? false
• External users? false
• Open source license? true
• Active? true
• Fork? false

Repository metadata

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

• Host: GitHub
• URL: https://github.com/aguaclara-reach/aguaclara
• Owner: AguaClara-Reach
• License: mit
• Created: 2017-05-30T17:35:36.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2025-08-15T13:29:10.000Z (5 months ago)
• Last Synced: 2025-12-04T18:53:42.119Z (about 1 month ago)
• Topics: aguaclara, python, water-treatment
• Language: Python
• Homepage: https://aguaclara.github.io/aguaclara/
• Size: 15.6 MB
• Stars: 26
• Watchers: 10
• Forks: 13
• Open Issues: 6
• Releases: 56
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Citation: CITATION.cff

README.md

pip install aguaclara

pip install aguaclara --upgrade

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

# 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)
)

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://github.com/AguaClara-Reach/aguaclara/raw/refs/heads/main/tests/research/data/datalog_6-14-2018.xls", 
    columns = [3, 4], 
    x_axis = 0
)
plt.ylabel("Turbidity (NTU)")
plt.xlabel("Time (hr)")
plt.legend(("Influent", "Effluent"))

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Keller"
  given-names: "Ethan"
- family-names: "Si"
  given-names: "Hannah"
- family-names: "Leung"
  given-names: "Oliver"
- family-names: "Weber-Shirk"
  given-names: "Sage"
- family-names: "Chapin"
  given-names: "Fletcher T."
  orcid: "https://orcid.org/0000-0002-2165-7963"
- family-names: "Chan"
  given-names: "Cynthia T."
- family-names: "Newatia"
  given-names: "Karan"
- family-names: "Sarmiento"
  given-names: "Kevin"
- family-names: "Yao-Smith"
  given-names: "Aaron"
- family-names: "Maisel"
  given-names: "Zoe"
- family-names: "Zhao"
  given-names: "Alice"
- family-names: "Verghese"
  given-names: "Anthony"
- family-names: "Lin"
  given-names: "Annabel"
- family-names: "Wong"
  given-names: "Fawn"
- family-names: "Pertsalis"
  given-names: "Elena"
- family-names: "Guzman"
  given-names: "Juan"
- family-names: "Pennock"
  given-names: "William H."
  orcid: "https://orcid.org/0000-0002-7194-1372"
- family-names: "Curillo"
  given-names: "Arianna"
- family-names: "Chiu"
  given-names: "Dylan T."
- family-names: "Lee"
  given-names: "Inwon"
- family-names: "Chaki"
  given-names: "Swastik"
- family-names: "Bediako"
  given-names: "Cynoc"
- family-names: "Vaishnavi"
  given-names: "Vinodhkanna"
- family-names: "Bhatti"
  given-names: "Aadil Z."
- family-names: "Weber-Shirk"
  given-names: "Monroe"
  orcid: "https://orcid.org/0000-0001-8037-7710"
title: "The AguaClara Package"
version: 0.4.0
date-released: 2023-02-08
doi: 10.5281/zenodo.16748574
url: "https://github.com/AguaClara-Reach/aguaclara"

Owner metadata

• Name: AguaClara Reach
• Login: AguaClara-Reach
• Email:
• Kind: organization
• Description:
• Website:
• Location: Ithaca, NY
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/42070153?v=4
• Repositories: 1
• Last ynced at: 2025-08-04T00:46:18.437Z
• Profile URL: https://github.com/AguaClara-Reach

GitHub Events

Total

• Release event: 3
• Delete event: 2
• Issue comment event: 4
• Push event: 7
• Pull request event: 4
• Create event: 5

Last Year

• Release event: 3
• Delete event: 2
• Issue comment event: 4
• Push event: 7
• Pull request event: 4
• Create event: 5

Committers metadata

Last synced: 6 days ago

Committer domains:

• cornell.edu: 13
• dhcp-hol-2928.eduroam.cornell.edu: 1
• dhcp-hol-852.eduroam.cornell.edu: 1
• dhcp-hol-875.eduroam.cornell.edu: 1
• dhcp-mcfad-2370.eduroam.cornell.edu: 1
• dhcp-mcfad-6856.eduroam.cornell.edu: 1
• dhcp-hol-973.eduroam.cornell.edu: 1
• dhcp-mcfad-11387.eduroam.cornell.edu: 1
• earlham.edu: 1

Issue and Pull Request metadata

Last synced: 3 months ago

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 320 last-month
• Total dependent packages: 0
• Total dependent repositories: 2
• Total versions: 46
• Total maintainers: 2

Dependencies

Score: 12.742986980058536