Welcome to homelette’s documentation!

homelette is 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.

If you use homelette in your research, please cite the following article:

Philipp Junk, Christina Kiel, HOMELETTE: a unified interface to homology modelling software, Bioinformatics, 2021;, btab866, https://doi.org/10.1093/bioinformatics/btab866

Setting up homelette

This section explains how to set homelette up on your system. homelette is available on GitHub and PyPI. The easiest option to work with homelette is to use a docker container that has all dependencies already installed.

• Installation
• Docker

Tutorials

We have prepared a series of 7 tutorials which will teach the interested user everything about using the homelette package. This is a great place to get started with homelette.

For a more interactive experience, all tutorials are available as Jupyter Notebooks through our Docker container.

• Tutorial 1: Basics
• Tutorial 2: Model Generation
• Tutorial 3: Model Evaluation
• Tutorial 4: Extending homelette
• Tutorial 5: Parallelization
• Tutorial 6: Complex Modelling
• Tutorial 7: Assembling Modelling Pipelines
• Tutorial 8: Automatic Alignment Generation

API Documentation

This is the documentation for all classes, methods and functions in homelette.

• Organization
• Sequences and Alignments
• Routines
• Evaluation
• PDB File interface

Extensions

homelette can be extended by new building blocks. This section introduces how extensions work, and where to find them.

• Extension Overview

Indices and tables

• Index

• Module Index