cosasi
COntagion Simulation And Source Identification
Summary
cosasi is a Python package for graph diffusion source localization, allowing users to:
- perform and evaluate source inference using standard techniques from literature,
- contribute innovative localization methods to a growing core library, and
- benchmark new techniques against a battery of comparable schemes.
Installation
Installation via PyPI
pip install cosasi
Installation via GitHub
Clone the repo from here.
Install requirements:
pip install -r requirements.txt
Getting Started
Once cosasi is installed, feel free to review our tutorial introducing major functionality. Official documentation, including a detailed API reference, is available on Read the Docs.
Testing
Extensive unit testing is employed throughout, with ~97% code coverage.
If you’ve cloned our repo from GitHub, you can cd into the root directory and run pytest via coverage:
coverage run -m pytest
To read the .coverage file:
coverage report
Citing
If you found cosasi helpful in your work, please consider citing it with:
@article{McCabe2022joss,
doi = {10.21105/joss.04894},
url = {https://doi.org/10.21105/joss.04894},
year = {2022},
publisher = {The Open Journal},
volume = {7},
number = {80},
pages = {4894},
author = {Lucas H. McCabe},
title = {cosasi: Graph Diffusion Source Inference in Python},
journal = {Journal of Open Source Software}
}
McCabe, L. H., (2022). cosasi: Graph Diffusion Source Inference in Python. Journal of Open Source Software, 7(80), 4894, https://doi.org/10.21105/joss.04894
Support
cosasi was developed in Forge, the technology accelerator of the Logistics Management Institute.