Skip to content

Perform pairwise secondary structural alignments of proteins using the US-align (TM-align) algorithm and generate an accompanying dendrogram to visualise the structural relationship between them.

License

Notifications You must be signed in to change notification settings

crfield18/ColabAlign

Repository files navigation

ColabAlign

Fast pairwise protein secondary structure comparisons using multiprocessing

Open In Colab Code DOI Paper DOI

This notebook performs pairwise protein structural alignments using the US-align algorithm by Zhang et al., (2022), then constructs a structure-informed dendrogram using the UPGMA algorithm to visualise similarities.

Designed to run directly in Google Colab for ease-of-use and to remove any local hardware requirements. This implementation also includes multiprocessing support for dramatically increased performance over the base US-align program.


Installation for local usage

ColabAlign.py is designed to work for Google Colab and running on local machines. A YAML file is provided for easy installation of dependencies in a Conda environment.

On Linux (distro-dependent) and x86 Macs (i.e. pre-M1), simply create an environment with:

conda env create -f colabalign.yml

On ARM-based Macs (M1 onwards)

Rosetta 2 is required:

softwareupdate --install-rosetta

and an extra flag is needed that allows x86-only scripts:

conda env create --platform osx-64 -f colabalign.yml


References

BibTeX-formatted references for this project and the associated references can be found in colabalign.bib and associated-references.bib.


Important

Permission to use, copy, modify, and distribute this program for any purpose, with or without fee, is hereby granted, provided that the notices on the head, the reference information, and this copyright notice appear in all copies or substantial portions of the Software. It is provided "as is" without express or implied warranty.

About

Perform pairwise secondary structural alignments of proteins using the US-align (TM-align) algorithm and generate an accompanying dendrogram to visualise the structural relationship between them.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published