| Name | drive-ibd JSON |
| Version |
3.0.1
JSON |
| download |
| home_page | None |
| Summary | Python CLI using graph theory to identify networks of individuals who share IBD segments overlapping loci of interest |
| upload_time | 2025-06-17 16:19:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | !=3.11.0,<3.12,>=3.9 |
| license | Apache-2.0 |
| keywords |
python
genetics
identity by descent
relatedness
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://drive-ibd.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
[](https://badge.fury.io/py/drive-ibd)
[](https://github.com/belowlab/drive/actions/workflows/python-app.yml)
# DRIVE:
This repository contains the source code for the tool DRIVE (Distant Relatedness for Identification and Variant Evaluation) is a novel approach to IBD-based genotype inference used to identify shared chromosomal segments in dense genetic arrays. DRIVE implements a random walk algorithm that identifies clusters of individuals who pairwise share an IBD segment overlapping a locus of interest. This tool was developed in python by the Below Lab at Vanderbilt University. The documentation for how to use this tool can be found here [DRIVE documentation](https://drive-ibd.readthedocs.io/en/latest/)
## Installing DRIVE:
DRIVE is available on PYPI and can easily be installed using the following command:
```bash
pip install drive-ibd
```
It is recommended to install DRIVE within a virtual environment such as venv, or conda. More information about this process can be found within the documentation.
If the user wishes to develop DRIVE or install the program from source then they can clone the repository. This process is described under the section called "Github Installation" in the documentation.
DRIVE is also available on Docker. The docker image can be found here "jtb114/drive".
If you are working on an HPC cluster it may be better to use a singularity image. Singularity can pull the docker container and build a singularity image with the following command:
```bash
singularity pull singularity-image-name.sif docker://jtb114/drive:latest
```
### Reporting issues:
If you wish to report a bug or propose a feature you can find templates under the .github/ISSUE_TEMPLATE directory.
Raw data
{
"_id": null,
"home_page": null,
"name": "drive-ibd",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.11.0,<3.12,>=3.9",
"maintainer_email": "James Baker <james.baker@vanderbilt.edu>, Hung-Hsin Chen <hung-hsin.chen.1@vumc.org>",
"keywords": "python, genetics, identity by descent, relatedness",
"author": null,
"author_email": "James Baker <james.baker@vanderbilt.edu>, Hung-Hsin Chen <hung-hsin.chen.1@vumc.org>, \"Jennifer E. Below\" <jennifer.e.below@vumc.org>",
"download_url": "https://files.pythonhosted.org/packages/0e/55/c0a25a0f870cfddbbe42e61b06fd6f3add022c61524aaf3b0d08ddf5b217/drive_ibd-3.0.1.tar.gz",
"platform": null,
"description": "[](https://drive-ibd.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/psf/black)\n[](https://badge.fury.io/py/drive-ibd)\n[](https://github.com/belowlab/drive/actions/workflows/python-app.yml)\n\n# DRIVE:\n\nThis repository contains the source code for the tool DRIVE (Distant Relatedness for Identification and Variant Evaluation) is a novel approach to IBD-based genotype inference used to identify shared chromosomal segments in dense genetic arrays. DRIVE implements a random walk algorithm that identifies clusters of individuals who pairwise share an IBD segment overlapping a locus of interest. This tool was developed in python by the Below Lab at Vanderbilt University. The documentation for how to use this tool can be found here [DRIVE documentation](https://drive-ibd.readthedocs.io/en/latest/)\n\n## Installing DRIVE:\nDRIVE is available on PYPI and can easily be installed using the following command:\n\n```bash\npip install drive-ibd\n```\nIt is recommended to install DRIVE within a virtual environment such as venv, or conda. More information about this process can be found within the documentation.\n\nIf the user wishes to develop DRIVE or install the program from source then they can clone the repository. This process is described under the section called \"Github Installation\" in the documentation.\n\nDRIVE is also available on Docker. The docker image can be found here \"jtb114/drive\".\n\nIf you are working on an HPC cluster it may be better to use a singularity image. Singularity can pull the docker container and build a singularity image with the following command:\n\n```bash\nsingularity pull singularity-image-name.sif docker://jtb114/drive:latest\n```\n\n### Reporting issues:\nIf you wish to report a bug or propose a feature you can find templates under the .github/ISSUE_TEMPLATE directory.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python CLI using graph theory to identify networks of individuals who share IBD segments overlapping loci of interest",
"version": "3.0.1",
"project_urls": {
"homepage": "https://drive-ibd.readthedocs.io/en/latest/",
"repository": "https://github.com/belowlab/drive"
},
"split_keywords": [
"python",
" genetics",
" identity by descent",
" relatedness"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "60f2e77b2a6c9928cb3a66b1394d6bb03437980f25810898be127703cdeb1f8f",
"md5": "2001073b684c416c1a606a7ffdab212d",
"sha256": "5fc8a0464ce5147041b42cfedb79dcc90935782b0c3ac7b052ef1d4f3c73a807"
},
"downloads": -1,
"filename": "drive_ibd-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2001073b684c416c1a606a7ffdab212d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "!=3.11.0,<3.12,>=3.9",
"size": 45289,
"upload_time": "2025-06-17T16:19:48",
"upload_time_iso_8601": "2025-06-17T16:19:48.424546Z",
"url": "https://files.pythonhosted.org/packages/60/f2/e77b2a6c9928cb3a66b1394d6bb03437980f25810898be127703cdeb1f8f/drive_ibd-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e55c0a25a0f870cfddbbe42e61b06fd6f3add022c61524aaf3b0d08ddf5b217",
"md5": "68116c153e20161ca1a05db95b0d81f3",
"sha256": "a7e7a0ff951aa96ddae39dfe8175b821458fbbff9e0896fb793ef0bcc4e39a8c"
},
"downloads": -1,
"filename": "drive_ibd-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "68116c153e20161ca1a05db95b0d81f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.11.0,<3.12,>=3.9",
"size": 96923454,
"upload_time": "2025-06-17T16:19:51",
"upload_time_iso_8601": "2025-06-17T16:19:51.675303Z",
"url": "https://files.pythonhosted.org/packages/0e/55/c0a25a0f870cfddbbe42e61b06fd6f3add022c61524aaf3b0d08ddf5b217/drive_ibd-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-06-17 16:19:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "belowlab",
"github_project": "drive",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "drive-ibd"
}
