Python package for creating simplified 2D protein visualisations. Specialised on showing differences and similaritys between proteins from the same protein family.
Project description
prot2d
Prot2d is a tool for 2D protein visualization aimed at improving the comparability of protein structures through standardized 2D visualizations. Prot2d focuses on creating highly comparable representations for same-family proteins.
Getting Started
prot2d needs python version: python= ">=3.10,<3.13"
Download prot2d via pip or poetry
- pip:
pip install prot2d
- Poetry:
poetry add prot2d
Install Foldseek
Instructions for downloading the Foldseek software can be found in Foldseek's GitHub
--> prot2d needs the path to the foldseek executable passed as argument to the main function to be used by the program.
Install dssp
Instructions for downloading dssp can be found here:
!The program runs on the mkdssp version 4.4.0! (some sources dont provide that (brew does!))
An example download workflow for usage can also be found in the google colab
First experiences with Google Colab
For users to get to know prot2d we've prepared a Google Colab notebook. This allows you to execute different prot2d's functionality on example structure and see the results without needing to set up the project locally.
Instructions in the Colab help with the first hands-on.
Documentation
Prot2d's documentation can found here:
important notes:
- input PDB files need a header to work (important for predicted structures)
- prot2d's methods can also be used via command line commands (cli)
Data
This project uses datasets that can be found on Zenodo. Additional example files can be found here aswell. You can access and download the data using the following link or DOI:
Example visualizations
1kt1 - domain visualization (family vis)
1kt1 - full protine visualization
Domain Annotation File Format:
The domain annotation is needed in the following format to be procceced by prot2d (methods for converting chainsaw annotations are included in the package documentation)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.