<p align="center">
<a href="https://github.com/jlsteenwyk/orthohmm">
<img src="https://raw.githubusercontent.com/JLSteenwyk/orthohmm/master/docs/_static/img/logo.png" alt="Logo" width="400">
</a>
<p align="center">
<a href="https://jlsteenwyk.com/orthohmm/">Docs</a>
·
<a href="https://github.com/jlsteenwyk/orthohmm/issues">Report Bug</a>
·
<a href="https://github.com/jlsteenwyk/orthohmm/issues">Request Feature</a>
</p>
<p align="center">
<a href="https://github.com/JLSteenwyk/orthohmm/actions" alt="Build">
<img src="https://img.shields.io/github/actions/workflow/status/JLSteenwyk/orthohmm/ci.yml?branch=main">
</a>
<a href="https://codecov.io/gh/JLSteenwyk/orthohmm" >
<img src="https://codecov.io/gh/JLSteenwyk/orthohmm/graph/badge.svg?token=YEXCJN8D4E"/>
</a>
<a href="https://github.com/jlsteenwyk/orthohmm/graphs/contributors" alt="Contributors">
<img src="https://img.shields.io/github/contributors/jlsteenwyk/orthohmm">
</a>
<a href="https://bsky.app/profile/jlsteenwyk.bsky.social" target="_blank" rel="noopener noreferrer">
<img src="https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff">
</a>
<br />
<a href="https://pepy.tech/badge/orthohmm">
<img src="https://static.pepy.tech/personalized-badge/orthohmm?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPi%20Downloads">
</a>
<a href="https://lbesson.mit-license.org/" alt="License">
<img src="https://img.shields.io/badge/License-MIT-blue.svg">
</a>
<a href="https://pypi.org/project/orthohmm/" alt="PyPI - Python Version">
<img src="https://img.shields.io/pypi/pyversions/orthohmm">
</a>
<a href="https://www.biorxiv.org/content/10.1101/2024.12.07.627370">
<img src="https://zenodo.org/badge/DOI/10.1101/2024.12.07.627370.svg">
</a>
</p>
</p>
OrthoHMM infers gene orthology using Hidden Markov Models.<br /><br />
If you found orthohmm useful, please cite *OrthoHMM: Improved Inference of Ortholog Groups using Hidden Markov Models*. Steenwyk et al. 2024, bioRxiv. doi: [10.1101/2024.12.07.627370](https://www.biorxiv.org/content/10.1101/2024.12.07.627370v1).
---
<br />
This documentation covers downloading and installing OrthoHMM. Details about each function as well as tutorials for using OrthoHMM are available in the [online documentation](https://jlsteenwyk.com/orthohmm/).
<br />
**Quick Start**
1\. Install external dependencies
OrthoHMM has two external dependencies — [HMMER](http://hmmer.org/download.html) and [mcl](https://github.com/micans/mcl?tab=readme-ov-file#installation-and-mcl-versions) — that can't be installed using pip.
Download and install these programs from their respective websites, which are linked in the previous sentence.
<br>
2\. Install OrthoHMM
```shell
# install
pip install orthohmm
# run
orthohmm <path_to_directory_of_FASTA_files>
```
<br />
**Installation**
**If you are having trouble installing OrthoHMM, please contact the lead developer, Jacob L. Steenwyk, via [email](https://jlsteenwyk.com/contact.html) or [Bluesky](https://bsky.app/profile/jlsteenwyk.bsky.social) to get help.**
1\. Install external dependencies
OrthoHMM has two external dependencies — [HMMER](http://hmmer.org/download.html) and [mcl](https://github.com/micans/mcl?tab=readme-ov-file#installation-and-mcl-versions) — that can't be installed using pip.
Download and install these programs from their respective websites, which are linked in the previous sentence.
<br>
2a\. Install OrthoHMM from pip
To install using *pip*, we recommend building a virtual environment to avoid software dependency issues. To do so, execute the following commands:
```shell
# create virtual environment
python -m venv venv
# activate virtual environment
source venv/bin/activate
# install orthohmm
pip install orthohmm
```
**Note, the virtual environment must be activated to use *orthohmm*.**
After using OrthoHMM, you may wish to deactivate your virtual environment and can do so using the following command:
```shell
# deactivate virtual environment
deactivate
```
<br />
2b\. Install OrthoHMM from source
Similarly, to install from source, we recommend using a virtual environment. To do so, use the following commands:
```shell
# download
git clone https://github.com/JLSteenwyk/orthohmm.git
cd orthohmm/
# create virtual environment
python -m venv venv
# activate virtual environment
source venv/bin/activate
# install
make install
```
To deactivate your virtual environment, use the following command:
```shell
# deactivate virtual environment
deactivate
```
**Note, the virtual environment must be activated to use *orthohmm*.**
<!-- <br />
To install via anaconda, execute the following command:
``` shell
conda install bioconda::orthohmm
```
Visit here for more information: https://anaconda.org/bioconda/orthohmm -->
Raw data
{
"_id": null,
"home_page": "https://github.com/jlsteenwyk/orthohmm",
"name": "orthohmm",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Jacob L. Steenwyk",
"author_email": "jlsteenwyk@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/90/ed/6ea52840e41b87f8ec537d2bc3f1ab9f2cadb1a8a3cc4f677dd11e01c256/orthohmm-0.1.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/jlsteenwyk/orthohmm\">\n <img src=\"https://raw.githubusercontent.com/JLSteenwyk/orthohmm/master/docs/_static/img/logo.png\" alt=\"Logo\" width=\"400\">\n </a>\n <p align=\"center\">\n <a href=\"https://jlsteenwyk.com/orthohmm/\">Docs</a>\n \u00b7\n <a href=\"https://github.com/jlsteenwyk/orthohmm/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/jlsteenwyk/orthohmm/issues\">Request Feature</a>\n </p>\n <p align=\"center\">\n <a href=\"https://github.com/JLSteenwyk/orthohmm/actions\" alt=\"Build\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/JLSteenwyk/orthohmm/ci.yml?branch=main\">\n </a>\n <a href=\"https://codecov.io/gh/JLSteenwyk/orthohmm\" >\n <img src=\"https://codecov.io/gh/JLSteenwyk/orthohmm/graph/badge.svg?token=YEXCJN8D4E\"/>\n </a>\n <a href=\"https://github.com/jlsteenwyk/orthohmm/graphs/contributors\" alt=\"Contributors\">\n <img src=\"https://img.shields.io/github/contributors/jlsteenwyk/orthohmm\">\n </a>\n <a href=\"https://bsky.app/profile/jlsteenwyk.bsky.social\" target=\"_blank\" rel=\"noopener noreferrer\">\n <img src=\"https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff\">\n </a>\n <br />\n <a href=\"https://pepy.tech/badge/orthohmm\">\n <img src=\"https://static.pepy.tech/personalized-badge/orthohmm?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPi%20Downloads\">\n </a>\n <a href=\"https://lbesson.mit-license.org/\" alt=\"License\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\">\n </a>\n <a href=\"https://pypi.org/project/orthohmm/\" alt=\"PyPI - Python Version\">\n <img src=\"https://img.shields.io/pypi/pyversions/orthohmm\">\n </a>\n <a href=\"https://www.biorxiv.org/content/10.1101/2024.12.07.627370\">\n <img src=\"https://zenodo.org/badge/DOI/10.1101/2024.12.07.627370.svg\"> \n </a> \n </p>\n</p>\n\n\nOrthoHMM infers gene orthology using Hidden Markov Models.<br /><br />\nIf you found orthohmm useful, please cite *OrthoHMM: Improved Inference of Ortholog Groups using Hidden Markov Models*. Steenwyk et al. 2024, bioRxiv. doi: [10.1101/2024.12.07.627370](https://www.biorxiv.org/content/10.1101/2024.12.07.627370v1).\n\n---\n\n<br />\n\nThis documentation covers downloading and installing OrthoHMM. Details about each function as well as tutorials for using OrthoHMM are available in the [online documentation](https://jlsteenwyk.com/orthohmm/).\n\n<br />\n\n**Quick Start**\n\n1\\. Install external dependencies\n\nOrthoHMM has two external dependencies \u2014 [HMMER](http://hmmer.org/download.html) and [mcl](https://github.com/micans/mcl?tab=readme-ov-file#installation-and-mcl-versions) \u2014 that can't be installed using pip.\nDownload and install these programs from their respective websites, which are linked in the previous sentence.\n\n<br>\n\n2\\. Install OrthoHMM\n\n```shell\n# install\npip install orthohmm \n# run\northohmm <path_to_directory_of_FASTA_files>\n```\n\n<br />\n\n**Installation**\n\n**If you are having trouble installing OrthoHMM, please contact the lead developer, Jacob L. Steenwyk, via [email](https://jlsteenwyk.com/contact.html) or [Bluesky](https://bsky.app/profile/jlsteenwyk.bsky.social) to get help.**\n\n1\\. Install external dependencies\n\nOrthoHMM has two external dependencies \u2014 [HMMER](http://hmmer.org/download.html) and [mcl](https://github.com/micans/mcl?tab=readme-ov-file#installation-and-mcl-versions) \u2014 that can't be installed using pip.\nDownload and install these programs from their respective websites, which are linked in the previous sentence.\n\n<br>\n\n2a\\. Install OrthoHMM from pip\n\nTo install using *pip*, we recommend building a virtual environment to avoid software dependency issues. To do so, execute the following commands:\n```shell\n# create virtual environment\npython -m venv venv\n# activate virtual environment\nsource venv/bin/activate\n# install orthohmm\npip install orthohmm\n```\n**Note, the virtual environment must be activated to use *orthohmm*.**\n\nAfter using OrthoHMM, you may wish to deactivate your virtual environment and can do so using the following command:\n```shell\n# deactivate virtual environment\ndeactivate\n```\n\n<br />\n\n2b\\. Install OrthoHMM from source\n\nSimilarly, to install from source, we recommend using a virtual environment. To do so, use the following commands:\n```shell\n# download\ngit clone https://github.com/JLSteenwyk/orthohmm.git\ncd orthohmm/\n# create virtual environment\npython -m venv venv\n# activate virtual environment\nsource venv/bin/activate\n# install\nmake install\n```\nTo deactivate your virtual environment, use the following command:\n```shell\n# deactivate virtual environment\ndeactivate\n```\n**Note, the virtual environment must be activated to use *orthohmm*.**\n\n<!-- <br />\n\nTo install via anaconda, execute the following command:\n\n``` shell\nconda install bioconda::orthohmm\n```\nVisit here for more information: https://anaconda.org/bioconda/orthohmm -->\n",
"bugtrack_url": null,
"license": null,
"summary": "HMM-based orthology",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/jlsteenwyk/orthohmm"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c71c9d5541cd02e19fe75feaf5091b5a8825e287401a1ab735f2ea9841f1dbcd",
"md5": "e6e932a7758f7a42f9e1e3e8fda25545",
"sha256": "b51b58559baa95850dc9e9d244702d80a615e2392c216fcb1ca5e92508353b85"
},
"downloads": -1,
"filename": "orthohmm-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6e932a7758f7a42f9e1e3e8fda25545",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 17680,
"upload_time": "2024-12-25T13:48:02",
"upload_time_iso_8601": "2024-12-25T13:48:02.205471Z",
"url": "https://files.pythonhosted.org/packages/c7/1c/9d5541cd02e19fe75feaf5091b5a8825e287401a1ab735f2ea9841f1dbcd/orthohmm-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90ed6ea52840e41b87f8ec537d2bc3f1ab9f2cadb1a8a3cc4f677dd11e01c256",
"md5": "f3c03c6123276a4d42458bd0c4306514",
"sha256": "55920953bf78c74277272f281b0e5b22d815f6d3f2f9ecc1e079c848d43d9c0e"
},
"downloads": -1,
"filename": "orthohmm-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f3c03c6123276a4d42458bd0c4306514",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16546,
"upload_time": "2024-12-25T13:48:04",
"upload_time_iso_8601": "2024-12-25T13:48:04.279747Z",
"url": "https://files.pythonhosted.org/packages/90/ed/6ea52840e41b87f8ec537d2bc3f1ab9f2cadb1a8a3cc4f677dd11e01c256/orthohmm-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-25 13:48:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jlsteenwyk",
"github_project": "orthohmm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Cython",
"specs": [
[
"==",
"3.0.4"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"2.0.1"
]
]
}
],
"lcname": "orthohmm"
}
JSON
