[![Documentation Status](https://readthedocs.org/projects/elpigraph-python/badge/?version=latest)](https://elpigraph-python.readthedocs.io/en/latest/?badge=latest)
[![GitHub license](https://img.shields.io/github/license/j-bac/elpigraph-python)](https://github.com/j-bac/elpigraph-python/blob/master/LICENSE)
[![DOI:10.3390/e22030296](https://img.shields.io/badge/DOI-10.3390%2Fe22030296-blue)](https://doi.org/10.3390/e22030296)
Description
===========
This package provides a Python implementation of the ElPiGraph algorithm with cpu and gpu support. Usage is explained in the [documentation](https://elpigraph-python.readthedocs.io/en/latest/) and a
self-contained description of the algorithm is available
[here](https://github.com/auranic/Elastic-principal-graphs/blob/master/ElPiGraph_Methods.pdf)
or in the [paper](https://www.mdpi.com/1099-4300/22/3/296)
It replicates the [R implementation](https://github.com/j-bac/ElPiGraph.R),
coded by [Luca Albergante](https://github.com/Albluca) and should return exactly the same results. Please open an issue if you do notice different output. Differences between the two versions are detailed in [differences.md](differences.md). This package extends initial work by [Louis Faure](https://github.com/LouisFaure/ElPiGraph.P) and [Alexis Martin](https://github.com/AlexiMartin/ElPiGraph.P).
A native MATLAB implementation of the algorithm (coded by [Andrei
Zinovyev](https://github.com/auranic/) and [Evgeny
Mirkes](https://github.com/Mirkes)) is also
[available](https://github.com/auranic/Elastic-principal-graphs)
Requirements
============
Requirements are listed in requirements.txt. In addition, to enable gpu support cupy is needed:
https://docs-cupy.chainer.org/en/stable/install.html
Installation
====================
```bash
git clone https://github.com/j-bac/elpigraph-python.git
cd elpigraph
pip install .
```
or
```bash
pip install elpigraph-python
```
Citation
========
When using this package, please cite our [paper](https://www.mdpi.com/1099-4300/22/3/296):
Albergante, L. et al . Robust and Scalable Learning of Complex Intrinsic Dataset Geometry via ElPiGraph (2020)
Raw data
{
"_id": null,
"home_page": "https://github.com/j-bac/elpigraph-python",
"name": "elpigraph-python",
"maintainer": "Jonathan Bac",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "machine_learning graphs dimension_reduction single_cell",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/59/6d/bbd9f251a658bca42b3023f39fa81d5c3daa29790b664f55a81e2bec3790/elpigraph-python-0.3.1.tar.gz",
"platform": null,
"description": "[![Documentation Status](https://readthedocs.org/projects/elpigraph-python/badge/?version=latest)](https://elpigraph-python.readthedocs.io/en/latest/?badge=latest)\n[![GitHub license](https://img.shields.io/github/license/j-bac/elpigraph-python)](https://github.com/j-bac/elpigraph-python/blob/master/LICENSE)\n[![DOI:10.3390/e22030296](https://img.shields.io/badge/DOI-10.3390%2Fe22030296-blue)](https://doi.org/10.3390/e22030296)\n\nDescription\n===========\n\nThis package provides a Python implementation of the ElPiGraph algorithm with cpu and gpu support. Usage is explained in the [documentation](https://elpigraph-python.readthedocs.io/en/latest/) and a\nself-contained description of the algorithm is available\n[here](https://github.com/auranic/Elastic-principal-graphs/blob/master/ElPiGraph_Methods.pdf)\nor in the [paper](https://www.mdpi.com/1099-4300/22/3/296)\n\nIt replicates the [R implementation](https://github.com/j-bac/ElPiGraph.R),\ncoded by [Luca Albergante](https://github.com/Albluca) and should return exactly the same results. Please open an issue if you do notice different output. Differences between the two versions are detailed in [differences.md](differences.md). This package extends initial work by [Louis Faure](https://github.com/LouisFaure/ElPiGraph.P) and [Alexis Martin](https://github.com/AlexiMartin/ElPiGraph.P).\n\nA native MATLAB implementation of the algorithm (coded by [Andrei\nZinovyev](https://github.com/auranic/) and [Evgeny\nMirkes](https://github.com/Mirkes)) is also\n[available](https://github.com/auranic/Elastic-principal-graphs)\n\nRequirements\n============\n\nRequirements are listed in requirements.txt. In addition, to enable gpu support cupy is needed:\nhttps://docs-cupy.chainer.org/en/stable/install.html\n\nInstallation\n====================\n```bash\ngit clone https://github.com/j-bac/elpigraph-python.git\ncd elpigraph\npip install .\n```\nor\n\n```bash\npip install elpigraph-python\n```\n\nCitation\n========\n\nWhen using this package, please cite our [paper](https://www.mdpi.com/1099-4300/22/3/296):\nAlbergante, L. et al . Robust and Scalable Learning of Complex Intrinsic Dataset Geometry via ElPiGraph (2020)\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.3.1",
"split_keywords": [
"machine_learning",
"graphs",
"dimension_reduction",
"single_cell"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c96ec6900e4a85555700a9e70dc589f89b2a3adea864c5bd1897b9bb6096347",
"md5": "7ec6f593d6f1c71acc1f85dc6cba392d",
"sha256": "576c48ec3e7e15dcb9cfc3e2743c0b28fe8ad7182e7bf5e7d6c0401e006b534e"
},
"downloads": -1,
"filename": "elpigraph_python-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ec6f593d6f1c71acc1f85dc6cba392d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 110134,
"upload_time": "2023-04-14T13:41:14",
"upload_time_iso_8601": "2023-04-14T13:41:14.971805Z",
"url": "https://files.pythonhosted.org/packages/2c/96/ec6900e4a85555700a9e70dc589f89b2a3adea864c5bd1897b9bb6096347/elpigraph_python-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "596dbbd9f251a658bca42b3023f39fa81d5c3daa29790b664f55a81e2bec3790",
"md5": "11d7d4fed1b94f21f4a127dc6c08a29b",
"sha256": "875ac455f9c79fb9d91f1b9bfa19c4ce8c9ee4e0a3535f5c6073830732bb55ff"
},
"downloads": -1,
"filename": "elpigraph-python-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "11d7d4fed1b94f21f4a127dc6c08a29b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 105881,
"upload_time": "2023-04-14T13:41:17",
"upload_time_iso_8601": "2023-04-14T13:41:17.642566Z",
"url": "https://files.pythonhosted.org/packages/59/6d/bbd9f251a658bca42b3023f39fa81d5c3daa29790b664f55a81e2bec3790/elpigraph-python-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-14 13:41:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "j-bac",
"github_project": "elpigraph-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.16.2"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"0.23.4"
]
]
},
{
"name": "numba",
"specs": [
[
">=",
"0.49.1"
]
]
},
{
"name": "scikit-learn",
"specs": [
[
">=",
"0.21.3"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.2.0"
]
]
},
{
"name": "python_igraph",
"specs": [
[
">=",
"0.7.1"
]
]
},
{
"name": "networkx",
"specs": [
[
">=",
"2.0"
]
]
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "shapely",
"specs": []
}
],
"lcname": "elpigraph-python"
}