diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-aguaclara.spec | 367 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 369 insertions, 0 deletions
@@ -0,0 +1 @@ +/aguaclara-0.3.4.tar.gz diff --git a/python-aguaclara.spec b/python-aguaclara.spec new file mode 100644 index 0000000..dd5919b --- /dev/null +++ b/python-aguaclara.spec @@ -0,0 +1,367 @@ +%global _empty_manifest_terminate_build 0 +Name: python-aguaclara +Version: 0.3.4 +Release: 1 +Summary: An open-source Python package for designing and performing research on AguaClara water treatment plants. +License: MIT +URL: https://github.com/AguaClara/aguaclara +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/83/0f/bc006d37ad22254da9b87fea6487997646a91467d70cb17a2bb3f040a36e/aguaclara-0.3.4.tar.gz +BuildArch: noarch + +Requires: python3-matplotlib +Requires: python3-urllib3 +Requires: python3-pint +Requires: python3-pandas +Requires: python3-scipy +Requires: python3-onshape-client +Requires: python3-numpy + +%description +# `aguaclara` +[](https://pypi.org/project/aguaclara/) +[](https://aguaclara.github.io/aguaclara/) +[](https://github.com/AguaClara/aguaclara/actions) +[](https://app.codecov.io/gh/AguaClara/aguaclara/) + +`aguaclara` is a Python package developed by [AguaClara Cornell](http://aguaclara.cornell.edu/) and [AguaClara Reach](https://www.aguaclarareach.org/) 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](https://monroews.github.io/EnvEngLabTextbook/ProCoDA/ProCoDA.html) (process control and data acquisition tool) + + +## Installing +The `aguaclara` package can be installed from Pypi by running the following command in the command line: + +```bash +pip install aguaclara +``` +To upgrade an existing installation, run + +```bash +pip install aguaclara --upgrade +``` + +## Using `aguaclara` +`aguaclara`'s main functionalities come from several sub-packages. + +1. **Core**: fundamental physical, chemical, and hydraulic functions and values +2. **Design**: modules for designing components of an AguaClara water treatment plant +3. **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](https://pint.readthedocs.io/en/latest/)), 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 +```python +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 +```python +# 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 +```python +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](https://aguaclara.github.io/aguaclara/api.html). + +## Contributing +Bug reports, features requests, documentation updates, and any other enhancements are welcome! To suggest a change, [make an issue](https://github.com/AguaClara/aguaclara/issues/new/choose) in the [`aguaclara` Github repository](https://github.com/AguaClara/aguaclara>). + +To contribute to the package as a developer, refer to the [Developer Guide](https://aguaclara.github.io/aguaclara/guide-dev/guide-dev.html). + + + + +%package -n python3-aguaclara +Summary: An open-source Python package for designing and performing research on AguaClara water treatment plants. +Provides: python-aguaclara +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-aguaclara +# `aguaclara` +[](https://pypi.org/project/aguaclara/) +[](https://aguaclara.github.io/aguaclara/) +[](https://github.com/AguaClara/aguaclara/actions) +[](https://app.codecov.io/gh/AguaClara/aguaclara/) + +`aguaclara` is a Python package developed by [AguaClara Cornell](http://aguaclara.cornell.edu/) and [AguaClara Reach](https://www.aguaclarareach.org/) 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](https://monroews.github.io/EnvEngLabTextbook/ProCoDA/ProCoDA.html) (process control and data acquisition tool) + + +## Installing +The `aguaclara` package can be installed from Pypi by running the following command in the command line: + +```bash +pip install aguaclara +``` +To upgrade an existing installation, run + +```bash +pip install aguaclara --upgrade +``` + +## Using `aguaclara` +`aguaclara`'s main functionalities come from several sub-packages. + +1. **Core**: fundamental physical, chemical, and hydraulic functions and values +2. **Design**: modules for designing components of an AguaClara water treatment plant +3. **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](https://pint.readthedocs.io/en/latest/)), 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 +```python +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 +```python +# 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 +```python +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](https://aguaclara.github.io/aguaclara/api.html). + +## Contributing +Bug reports, features requests, documentation updates, and any other enhancements are welcome! To suggest a change, [make an issue](https://github.com/AguaClara/aguaclara/issues/new/choose) in the [`aguaclara` Github repository](https://github.com/AguaClara/aguaclara>). + +To contribute to the package as a developer, refer to the [Developer Guide](https://aguaclara.github.io/aguaclara/guide-dev/guide-dev.html). + + + + +%package help +Summary: Development documents and examples for aguaclara +Provides: python3-aguaclara-doc +%description help +# `aguaclara` +[](https://pypi.org/project/aguaclara/) +[](https://aguaclara.github.io/aguaclara/) +[](https://github.com/AguaClara/aguaclara/actions) +[](https://app.codecov.io/gh/AguaClara/aguaclara/) + +`aguaclara` is a Python package developed by [AguaClara Cornell](http://aguaclara.cornell.edu/) and [AguaClara Reach](https://www.aguaclarareach.org/) 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](https://monroews.github.io/EnvEngLabTextbook/ProCoDA/ProCoDA.html) (process control and data acquisition tool) + + +## Installing +The `aguaclara` package can be installed from Pypi by running the following command in the command line: + +```bash +pip install aguaclara +``` +To upgrade an existing installation, run + +```bash +pip install aguaclara --upgrade +``` + +## Using `aguaclara` +`aguaclara`'s main functionalities come from several sub-packages. + +1. **Core**: fundamental physical, chemical, and hydraulic functions and values +2. **Design**: modules for designing components of an AguaClara water treatment plant +3. **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](https://pint.readthedocs.io/en/latest/)), 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 +```python +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 +```python +# 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 +```python +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](https://aguaclara.github.io/aguaclara/api.html). + +## Contributing +Bug reports, features requests, documentation updates, and any other enhancements are welcome! To suggest a change, [make an issue](https://github.com/AguaClara/aguaclara/issues/new/choose) in the [`aguaclara` Github repository](https://github.com/AguaClara/aguaclara>). + +To contribute to the package as a developer, refer to the [Developer Guide](https://aguaclara.github.io/aguaclara/guide-dev/guide-dev.html). + + + + +%prep +%autosetup -n aguaclara-0.3.4 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-aguaclara -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.4-1 +- Package Spec generated @@ -0,0 +1 @@ +ea25cf324dca355aaf4a3b25ed02a89b aguaclara-0.3.4.tar.gz |