[](https://doi.org/10.5281/zenodo.13929233)
[](https://doi.org/10.21105/joss.05554)
# 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/).
## 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](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](https://doi.org/10.1007/978-1-4615-0407-8).
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/pnsaevik/effluent",
"name": "effluent",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "pipes turbulent jets plumes ocean",
"author": "P\u00e5l N\u00e6verlid S\u00e6vik",
"author_email": "paal.naeverlid.saevik@hi.no",
"download_url": "https://files.pythonhosted.org/packages/76/96/ab9b1b1440eaf9a720df785f1fef4346adbe3f0e7966d0b75f6dcd41d03a/effluent-1.5.0.tar.gz",
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.13929233)\n[](https://doi.org/10.21105/joss.05554)\n\n# effluent\n\nEffluent is a python package for simulating the dispersion of effluent\ndischarges from wastewater pipes. The underlying model is based on\nLee, Joseph H. W., and Chu, Vincent H.: *Turbulent Jets and Plumes*.\nBoston, MA: Springer US, 2003.\n[doi:10.1007/978-1-4615-0407-8](https://doi.org/10.1007/978-1-4615-0407-8).\n\nThe package is mainly intended for research purposes, and does not contain\nany convenience plotting or statistics functionality. It is expected that\nthese analyses are conducted in post-processing stages using other packages.\n\n\n## Installation\n\nThe package is installed using pip:\n\n pip install effluent\n\nAlternatively, the package can be installed to an isolated conda environment\nusing the in-repo file `environment.yml` as follows:\n\n conda env create -f environment.yml \n\n\n## Usage\n\nThe software is invoked as a command line script:\n\n effluent config.toml\n\nwhere `config.toml` is the configuration file specifying the simulation\nsetup. Examples of valid configuration files are given in the repository\ndirectory `docs/source/examples`, and in the\n[online documentation](https://effluent.readthedocs.io/en/latest/).\n\n\n## Citation\n\nIf you use the software in a publication or report, please cite it as follows:\n\nS\u00e6vik, P. N., (2023). _Effluent: A Python package for modelling effluent discharge_.\nJournal of Open Source Software, **8**(89), \n[https://doi.org/10.21105/joss.05554](https://doi.org/10.21105/joss.05554).\n\nConsider also citing the work which this package is based on:\n\nLee, J. H. W., and Chu, V. H. (2003).\n_Turbulent Jets and Plumes - A Lagrangian Approach_. Boston, MA: Springer US.\n[https://doi.org/10.1007/978-1-4615-0407-8](https://doi.org/10.1007/978-1-4615-0407-8).\n\n\n## Documentation\n\nCheck out the\n[online documentation](https://effluent.readthedocs.io/en/latest/) for a\ndetailed description of the algorithm and software features.\n\n\n## How to contribute\n\nUse the GitHub issue tracking system to report problems with the software, seek\nsupport, or suggest improvements. Code contributions can be suggested using\nGitHub pull requests. Check documentation for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Simulate effluent discharges from wastewater pipes",
"version": "1.5.0",
"project_urls": {
"Changelog": "https://github.com/pnsaevik/effluent/blob/main/CHANGELOG.md",
"Documentation": "https://effluent.readthedocs.io/en/latest/",
"Homepage": "https://github.com/pnsaevik/effluent"
},
"split_keywords": [
"pipes",
"turbulent",
"jets",
"plumes",
"ocean"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "171afa2850215008987666cc71ce66f4bf3634f379d25777664ad387117da7bd",
"md5": "f63fd0d980cc44dd3a193f3f36bc9cd2",
"sha256": "0cfc7d7ae622ce73de39213e622e6347895b2c6b4ba4f0590fd264191e10af52"
},
"downloads": -1,
"filename": "effluent-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f63fd0d980cc44dd3a193f3f36bc9cd2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 21324,
"upload_time": "2024-10-16T13:15:06",
"upload_time_iso_8601": "2024-10-16T13:15:06.189654Z",
"url": "https://files.pythonhosted.org/packages/17/1a/fa2850215008987666cc71ce66f4bf3634f379d25777664ad387117da7bd/effluent-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7696ab9b1b1440eaf9a720df785f1fef4346adbe3f0e7966d0b75f6dcd41d03a",
"md5": "1415593ca3808e3d67328bce6f48ba3d",
"sha256": "d51b550c9bab019629a96665d2772d96d60334f367781c1070d288566a5864d3"
},
"downloads": -1,
"filename": "effluent-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "1415593ca3808e3d67328bce6f48ba3d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 26402,
"upload_time": "2024-10-16T13:15:07",
"upload_time_iso_8601": "2024-10-16T13:15:07.757937Z",
"url": "https://files.pythonhosted.org/packages/76/96/ab9b1b1440eaf9a720df785f1fef4346adbe3f0e7966d0b75f6dcd41d03a/effluent-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 13:15:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pnsaevik",
"github_project": "effluent",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "effluent"
}
JSON
