Skip to main content

Detector for XH-pi interactions in protein structures.

Project description

Xpid

Xpid is a Gemmi-based tool designed to detect XH-π interactions in PDB/mmCIF files.

Installation

Requires Python 3.9+.

git clone https://github.com/SeanWang5868/xpid
cd xpid
pip install .

Configuration

The detection of XH-π interactions depends on the position of H atoms. In order to add H to the structure before detecting, the path to the monomer library (e.g. CCP4 monomer library) needs to be specified.

xpid --set-mon-lib /Users/abc123/monomers

Quick Start

Scans a directory or PDB/mmCIF file and save results into a JSON file.

xpid ./data

Output: ./data/xpid_output/xpid_results.json

Geometric Criteria

Definitions: $C_\pi$ (Ring Centroid), $\vec{n}$ (Ring Normal), $X$ (Donor Heavy Atom), $Xp$ (The projection of X onto the π plane), $H$ (Hydrogen).

Hudson System

$d_{X \text{--} C_\pi}$: $\le 4.5$ Å, $\angle X\text{--}H \text{--} \vec{n}$): $\le 40^\circ$. $d_{Xp \text{--} C_\pi}$: $\le 1.6$ Å $\text{for His, Trp-A}$, $\le 2.0$ Å $\text{for Phe, Trp-B, Tyr}$.

Plevin System

$d_{X \text{--} C_\pi}$: $< 4.3$ Å, $\angle X\text{--}H \text{--} C_\pi$: $> 120^\circ$, $\angle X \text{--} C_\pi \text{--} \vec{n}$): $< 25^\circ$.

Command Options

Argument Description
inputs Input file (.cif, .pdb) or directory path.
--out-dir Specify custom output directory.
--separate Save results as separate files per PDB (Default: Merge).
--file-type Output format: json (default) or csv.
-v, --verbose Output detailed metrics (angles, coords, B-factors).
--log Enable log file saving.
--jobs N Number of CPU cores to use (Default: 1).
--h-mode N Hydrogen handling mode (0=NoChange, 4=ReAddButWater).
--model ID Model index to analyze (Default: 0; use all for NMR).
--pi-res Limit acceptor residues (e.g., TRP,TYR).
--donor-res Limit donor residues (e.g., HIS,ARG).
--donor-atom Limit donor element types (e.g., N,O).

Output Data

Simple Mode (Default)

  • PDB ID, Resolution
  • Chain, Name, ID for X-donor and $\pi$ Residues.
  • Distance ($d_{X \text{--} C_\pi}$)

Detailed Mode (-v)

  • Includes all Simple fields plus:
  • Secondary structure: Type (H/G/I/E/C) and Region IDs.
  • Coordinates: Flattened x, y, z for $\pi$-center and X-atom.
  • Geometric parameters: $\angle X\text{--}H \text{--} \vec{n}$, $\angle X\text{--}H \text{--} C_\pi$, $\angle X \text{--} C_\pi \text{--} \vec{n}$, $d_{Xp \text{--} C_\pi}$
  • B-factors: Average B-factor for ring atoms and X-atom.

Dependencies

  • gemmi
  • numpy

Contact

Sean Wang (sean.wang@york.ac.uk)

York Structural Biology Laboratory (YSBL), University of York

xpid2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xpid-2.1.1.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xpid-2.1.1-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file xpid-2.1.1.tar.gz.

File metadata

  • Download URL: xpid-2.1.1.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for xpid-2.1.1.tar.gz
Algorithm Hash digest
SHA256 69aa8fab03cd070d58b8a0f3fefc1e98c031a3aacc173aab34244ee380bbcdd6
MD5 d4224f39d9bbaf2b8a061feeaae8e0ff
BLAKE2b-256 a0de519f7477b3308acdc67734a8d2f767f05a8a5feb6d4b4d2f3090be0eff7d

See more details on using hashes here.

File details

Details for the file xpid-2.1.1-py3-none-any.whl.

File metadata

  • Download URL: xpid-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 25.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for xpid-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef6be647baa270346dbd3f8c2d1dbd85484199fc52e75811819a1d9bec11b11a
MD5 8b51300b28e9ec14c21731163e943b22
BLAKE2b-256 47a7bb6cf2a69da5ea64f0065ff1491441cadee00db4bac154f3b6f3a5c139aa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page