![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/philippjunk/homelette)
![PyPI](https://img.shields.io/pypi/v/homelette)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/homelette)
![Read the Docs](https://img.shields.io/readthedocs/homelette)
![Docker Image Version (latest semver)](https://img.shields.io/docker/v/philippjunk/homelette_template)
![GitHub](https://img.shields.io/github/license/philippjunk/homelette)
# homelette
A Python package offering a unified interface to different software for generating and evaluating homology models. This enables users to easily assemble custom homology modelling pipelines. `homelette` is extensively documented, lightweight and easily extendable.
For more information, please check out our [online documentation](https://homelette.readthedocs.io/).
<img src="logo/logo.png" alt="Logo" width="400"/>
## Citing
If you use `homelette` in your research, please cite the [following article](https://doi.org/10.1093/bioinformatics/btab866):
Philipp Junk, Christina Kiel, HOMELETTE: a unified interface to homology modelling software, Bioinformatics, 2021;, btab866, https://doi.org/10.1093/bioinformatics/btab866
## Installation
The simplest way to use homelette is to access it through our prepared docker container. For more information, please check `homelette/docker` or the [documentation](https://homelette.readthedocs.io/).
homelette can also be installed from PIP.
```bash
python3 -m pip install homelette
```
Instructions on how to install homology modelling and evaluation dependencies can be found in our [documentation](https://homelette.readthedocs.io/).
## Examples
There is a series of eight tutorials available demonstrating the use and extension of our homology modelling interface. Tutorials are available on our [documentation webpage](https://homelette.readthedocs.io/) or as interactive Jupyter Notebooks in our Docker image or in `homelette/examples`.
## License
homelette is freely available under the [MIT](https://choosealicense.com/licenses/mit/) license.
Raw data
{
"_id": null,
"home_page": "https://github.com/philippjunk/homelette/",
"name": "homelette",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "homology modelling,bioinformatics",
"author": "Philipp Junk, Christina Kiel",
"author_email": "philipp.junk@ucdconnect.ie",
"download_url": "https://files.pythonhosted.org/packages/42/67/ee3d1ba657b8eafa6ed300b692f3be19a2fc5c06ff799d7a51855e5bc5f0/homelette-1.4.tar.gz",
"platform": null,
"description": "\n![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/philippjunk/homelette)\n![PyPI](https://img.shields.io/pypi/v/homelette)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/homelette)\n![Read the Docs](https://img.shields.io/readthedocs/homelette)\n![Docker Image Version (latest semver)](https://img.shields.io/docker/v/philippjunk/homelette_template)\n![GitHub](https://img.shields.io/github/license/philippjunk/homelette)\n\n\n# homelette\n\nA Python package offering a unified interface to different software for generating and evaluating homology models. This enables users to easily assemble custom homology modelling pipelines. `homelette` is extensively documented, lightweight and easily extendable.\n\nFor more information, please check out our [online documentation](https://homelette.readthedocs.io/).\n\n<img src=\"logo/logo.png\" alt=\"Logo\" width=\"400\"/>\n\n## Citing\n\nIf you use `homelette` in your research, please cite the [following article](https://doi.org/10.1093/bioinformatics/btab866): \n\n Philipp Junk, Christina Kiel, HOMELETTE: a unified interface to homology modelling software, Bioinformatics, 2021;, btab866, https://doi.org/10.1093/bioinformatics/btab866\n\n## Installation\n\nThe simplest way to use homelette is to access it through our prepared docker container. For more information, please check `homelette/docker` or the [documentation](https://homelette.readthedocs.io/).\n\nhomelette can also be installed from PIP.\n\n```bash\npython3 -m pip install homelette\n```\n\nInstructions on how to install homology modelling and evaluation dependencies can be found in our [documentation](https://homelette.readthedocs.io/).\n\n## Examples\n\nThere is a series of eight tutorials available demonstrating the use and extension of our homology modelling interface. Tutorials are available on our [documentation webpage](https://homelette.readthedocs.io/) or as interactive Jupyter Notebooks in our Docker image or in `homelette/examples`.\n\n## License\n\nhomelette is freely available under the [MIT](https://choosealicense.com/licenses/mit/) license.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A unified and modular interface to homology modelling software",
"version": "1.4",
"split_keywords": [
"homology modelling",
"bioinformatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "726a0c8c3bdaaecaac23d0eee9999ac8a63a23376daa0f676e4f6394f6215f63",
"md5": "6f416bbc3ad1baf5a0048c1a195a52b7",
"sha256": "233de5cf962c6fa14411c85a2e6a5289b0a08cfb98aaa632e2638990d0f15f7a"
},
"downloads": -1,
"filename": "homelette-1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f416bbc3ad1baf5a0048c1a195a52b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 50038,
"upload_time": "2023-03-16T16:52:14",
"upload_time_iso_8601": "2023-03-16T16:52:14.784494Z",
"url": "https://files.pythonhosted.org/packages/72/6a/0c8c3bdaaecaac23d0eee9999ac8a63a23376daa0f676e4f6394f6215f63/homelette-1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4267ee3d1ba657b8eafa6ed300b692f3be19a2fc5c06ff799d7a51855e5bc5f0",
"md5": "f744ce1675148a2107d8e7c472719888",
"sha256": "e38daae96cd467f7d3b34e0da3e02633e57588b6b30024c6d838b69cdcce72ed"
},
"downloads": -1,
"filename": "homelette-1.4.tar.gz",
"has_sig": false,
"md5_digest": "f744ce1675148a2107d8e7c472719888",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 50731126,
"upload_time": "2023-03-16T16:52:22",
"upload_time_iso_8601": "2023-03-16T16:52:22.760193Z",
"url": "https://files.pythonhosted.org/packages/42/67/ee3d1ba657b8eafa6ed300b692f3be19a2fc5c06ff799d7a51855e5bc5f0/homelette-1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-16 16:52:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "philippjunk",
"github_project": "homelette",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "homelette"
}