Metadata-Version: 2.1
Name: effluent
Version: 1.3.2
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
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: pandas
Requires-Dist: netcdf4
Requires-Dist: scipy
Requires-Dist: dask
Requires-Dist: tomli
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-autoapi; extra == "dev"

[![CircleCI](
https://circleci.com/gh/pnsaevik/effluent/tree/main.svg?style=shield)
](https://circleci.com/gh/pnsaevik/effluent)
[![DOI](https://zenodo.org/badge/472699753.svg)](https://zenodo.org/badge/latestdoi/472699753)

# 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.: *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

Alternatively, the package can be installed to an isolated conda environment
using the in-repo file `environment.yml` as follows:

    conda env create -f environment.yml 


# Usage

The software is invoked as a command line script:

    effluent config.toml

where `config.toml` is the configuration file specifying the simulation
setup. Examples of valid configuration files are given in the repository
directory `docs/source/examples`, and in the
[online documentation](https://effluent.readthedocs.io/en/latest/).


# Documentation

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


# How to contribute

Use the GitHub issue tracking system to report problems with the software, seek
support, or suggest improvements. Code contributions can be suggested using
GitHub pull requests. Check documentation for details.
