Effluent: Pipe discharge model¶
What is effluent?¶
effluent is a python package for simulating the dispersion of effluent
discharges from wastewater pipes. The underlying model is based on
Lee, Joseph H. W., and Chu, Vincent H. (2003):
Turbulent Jets and Plumes - A Lagrangian Approach.
The package is mainly intended for research purposes, and does not contain plotting or statistics functionality. It is expected that these analyses are conducted in post-processing stages using other packages.
Citation¶
If you use the software in a publication or report, please cite it as follows:
Sævik, P. N., (2023). Effluent: A Python package for modelling effluent discharge. Journal of Open Source Software, 8(89), https://doi.org/10.21105/joss.05554
Consider also citing the work which this package is based on:
Lee, J. H. W., and Chu, V. H. (2003). Turbulent Jets and Plumes - A Lagrangian Approach. Boston, MA: Springer US. https://doi.org/10.1007/978-1-4615-0407-8.
Installation¶
The package is installed using pip:
pip install effluent
Usage¶
The software can be started from the command line as
effluent config.toml
or from within python as
import effluent
effluent.run("config.toml")
In both cases, simulation details are specified in the
file config.toml, written in the TOML file format.
The Examples section includes many examples of valid config files,
for various types of problems.