Skip to main content

TopModel

A python script to quickly inspect and highlight issues in structure models.

Tests

Installation

pip install git+https://github.com/liedllab/topmodel.git

Test Installation

topmodel --help

Command-Line Interface (CLI)

topmodel path/to/file*.pdb

TopModel is a command line tool that checks the chiralities, the amide bonds and overall VDW clashes in a structure model. Optionally, the structure can be opened in PyMOL to visualize the issues found. For this PyMOL needs to be in PATH.

Chirality

TopModel can assign L and D to aminoacids. In the command-line interface (CLI) only the D aminoacids are shown. The chirality is computed by computing a normal vector $\vec{n}$ to the plane defined by the triangle of the three highest priority atoms $A$ around the chiral center where the suffix denotes the priority.

$$\vec{n} = \overrightarrow{A_3A_1} \times \overrightarrow{A_3A_2}$$

The direction of the normal vector is determined by the orientation of the side chains. By calculating the dot product of the normal vector and a vector from the chiral center to the plane the relative orientation of the three atoms around the chiral center, and thus the chirality, can be determined from the sign of the result.

$$ chirality = \vec{n} \cdot \overrightarrow{A_3A_{center}} = \begin{cases} \mathbf{D}, \text{if } > 0 \ \mathbf{L}, \text{if } < 0 \end{cases} $$

Amide bonds

TopModel can assign CIS and TRANS to the amide bonds depending on the dihedral angle defined by $C_{\alpha}CNC_\alpha$. Amide bonds that could not be assigned to either CIS or TRANS are labeled as NON_PLANAR.

Cis amide bonds to prolines are labelled separately as they occur more frequently.

Clashes

TopModel detects Van der Waals clashes by calculating the distance between all pair of atoms that are within 5 Å of each other. A clash is defined by: $$d_{AB} < r_A + r_B - 0.5Å$$

As a package

TopModel can be imported as a package. The package contains the small modules chirality, amide_bond and clashes that provide functions to calculate the respective property.

import topmodel # or
from topmodel.check import chirality, amide_bond, clashes

Dependencies

  • biopython
  • scipy
  • mendeleev
  • Click
  • colorama
  • PyMOL (to open the structure in PyMOL)

Metadata

Release files for protein-topmodel 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for protein-topmodel 1.0.1
File Size Uploaded
protein_topmodel-1.0.1.tar.gz 12.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for protein-topmodel 1.0.1
File Interpreter ABI Platform
protein_topmodel-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 26.7 kB

Release files / protein_topmodel-1.0.1.tar.gz

Download URL protein_topmodel-1.0.1.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
09bf33b79068a2085553ce4ac8543f327a0eb97df5af7e6a57b0fa2a10094dd8
BLAKE2b-256 checksum
How to use checksums
0fd186960c739cc2b771d7c84ba976d56d35e3688fe4d8fafabb4d3a7e49e777
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / protein_topmodel-1.0.1-py3-none-any.whl

Download URL protein_topmodel-1.0.1-py3-none-any.whl
Size 14.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
97dbb9e5d8be9359ee0c76e287eee5747e9a4dd02dffd8cb0ed79b0c0d2ff050
BLAKE2b-256 checksum
How to use checksums
ee57ef7e5856a7c63363af51c5baa3f10baf0c08c987e653fa2dfdc5dcb2504d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page