semvec/pypi-packages huggingface dataset:
homelette 1.4
A unified and modular interface to homology modelling software
License: MIT
Requires Python: >=3.6
Keywords: homology modelling,bioinformatics

![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.