Effluent
Effluent: A Python package for modelling effluent discharge - Published in JOSS (2023)
Science Score: 98.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 18 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Basic Info
- Host: GitHub
- Owner: pnsaevik
- License: mit
- Language: Python
- Default Branch: main
- Size: 681 KB
Statistics
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 8
Metadata Files
README.md
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.
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.
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.
Documentation
Check out the online documentation 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.
Owner
- Name: Pål Næverlid Sævik
- Login: pnsaevik
- Kind: user
- Location: Bergen, Norway
- Company: Institute of Marine Science
- Repositories: 6
- Profile: https://github.com/pnsaevik
JOSS Publication
Effluent: A Python package for modelling effluent discharge
Authors
Institute of Marine Research, Norway
Editor
Kristen Thyng
Tags
wastewater turbulence outfalls plumesCitation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "Effluent: A Python package for modelling effluent discharge"
authors:
- family-names: "Sævik"
given-names: "Pål Næverlid"
orcid: "https://orcid.org/0000-0002-7301-2008"
doi: 10.5281/zenodo.8333370
version: 1.3.3
date-released: 2023-09-14
license: MIT
url: "https://effluent.readthedocs.io/en/latest/"
repository-code: "https://github.com/pnsaevik/effluent/"
preferred-citation:
title: "Effluent: A Python package for modelling effluent discharge"
authors:
- family-names: "Sævik"
given-names: "Pål Næverlid"
orcid: "https://orcid.org/0000-0002-7301-2008"
doi: 10.21105/joss.05554
url: https://doi.org/10.21105/joss.05554
year: 2023
publisher: The Open Journal
volume: 8
number: 89
pages: 5554
journal: Journal of Open Source Software
GitHub Events
Total
- Create event: 3
- Release event: 1
- Issues event: 1
- Push event: 4
- Pull request event: 2
Last Year
- Create event: 3
- Release event: 1
- Issues event: 1
- Push event: 4
- Pull request event: 2
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Pål Næverlid Sævik | p****k@h****o | 389 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 27
- Total pull requests: 28
- Average time to close issues: 18 days
- Average time to close pull requests: about 17 hours
- Total issue authors: 5
- Total pull request authors: 2
- Average comments per issue: 1.52
- Average comments per pull request: 0.43
- Merged pull requests: 27
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: 3 months
- Average time to close pull requests: 1 minute
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 2.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- pnsaevik (10)
- castelao (9)
- bastorer (6)
- stigdal (1)
- ivicajan (1)
Pull Request Authors
- pnsaevik (27)
- bastorer (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 25 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 13
- Total maintainers: 1
pypi.org: effluent
Simulate effluent discharges from wastewater pipes
- Homepage: https://github.com/pnsaevik/effluent
- Documentation: https://effluent.readthedocs.io/en/latest/
- License: MIT License
-
Latest release: 1.5.0
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- h5netcdf *
- matplotlib *
- pandas *
- scipy *
- xarray *
- actions/checkout v3 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- effluent *