https://github.com/mmore500/downstream
downstream is a library of stream curation algorithms
https://github.com/mmore500/downstream
Last synced: 4 months ago
JSON representation
downstream is a library of stream curation algorithms
- Host: GitHub
- URL: https://github.com/mmore500/downstream
- Owner: mmore500
- License: mit
- Created: 2024-03-24T16:57:37.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-22T04:50:54.000Z (8 months ago)
- Last Synced: 2024-10-26T08:56:11.434Z (8 months ago)
- Size: 4.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README

[](https://github.com/mmore500/downstream)
[

](https://pypi.python.org/pypi/downstream)

[](https://zenodo.org/doi/10.5281/zenodo.10866541)downstream provides efficient, constant-space implementations of stream curation algorithms.
- Free software: MIT license
## CI Status
[](https://github.com/mmore500/downstream/actions/workflows/cpp-ci.yaml?query=branch:cpp)
[](https://github.com/mmore500/downstream/actions/workflows/csl-ci.yaml?query=branch:csl)
[](https://github.com/mmore500/downstream/actions/workflows/python-ci.yaml?query=branch:python)
[](https://github.com/mmore500/downstream/actions/workflows/rust-ci.yaml?query=branch:csl)
[](https://github.com/mmore500/downstream/actions/workflows/zig-ci.yaml?query=branch:zig)## Installation
To install from PyPi with pip, run
`python3 -m pip install "downstream[jit]"`
A containerized release of `downstream` is available via
```bash
singularity exec docker://ghcr.io/mmore500/downstream python3 -m downstream --help
```## Documentation
Slide deck & graphics for this project are at .
See `https://github.com/mmore500/hstrat-surface-concept` for usage examples.
## Citing
If downstream contributes to a scientific publication, please cite it as
> Matthew Andres Moreno. (2024). mmore500/downstream. Zenodo. https://zenodo.org/doi/10.5281/zenodo.10866541
```bibtex
@software{moreno2024downstream,
author = {Matthew Andres Moreno},
title = {mmore500/downstream},
month = mar,
year = 2024,
publisher = {Zenodo},
doi = {10.5281/zenodo.10866541},
url = {https://zenodo.org/doi/10.5281/zenodo.10866541}
}
```And don't forget to leave a [star on GitHub](https://github.com/mmore500/downstream/stargazers)!
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [mmore500/cookiecutter-dishtiny-project](https://github.com/mmore500/cookiecutter-dishtiny-project) project template.