Metadata-Version: 2.1
Name: effluent
Version: 1.1
Summary: Simulate effluent discharges from wastewater pipes
Home-page: https://github.com/pnsaevik/effluent
Author: Pål Næverlid Sævik
Author-email: paal.naeverlid.saevik@hi.no
Project-URL: Documentation, https://effluent.readthedocs.io/en/latest/
Project-URL: Changelog, https://github.com/pnsaevik/effluent/blob/main/CHANGELOG.md
Keywords: pipes turbulent jets plumes ocean
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# effluent

**NOTE**: This package is under development and not all features are
implemented yet.

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.: *Turbulent Jets and Plumes*.
Boston, MA: Springer US, 2003.
[doi:10.1007/978-1-4615-0407-8](https://doi.org/10.1007/978-1-4615-0407-8>).

The package is mainly intended for research purposes, and does not contain
any convenience plotting or statistics functionality. It is expected that
these analyses are conducted in post-processing stages using other packages.


## Installation

The package is installed using pip:

    pip install effluent
  

# Usage

The software is invoked from the command line as

    python -m effluent config.toml

where `config.toml` is the configuration file specifying the simulation
setup.


# Documentation

Check out the
[online documentation](https://effluent.readthedocs.io/en/latest/) for a
description of the algorithm and software features.
