Skip to main content

Structure quality report and cleaning for PDB/mmCIF files

Project description

pdbqc

A Python tool for structure quality reporting and cleaning of PDB/mmCIF files. Detects and reports common structural pathologies — alternate locations, insertion codes, microheterogeneity, missing residues, and selenomethionine conversions — in a clean, colored terminal report.

Install

pip install pdbqc

Usage

Python

from pdbqc import clean_structure, format_report

# Basic usage
qc, structure = clean_structure("my_structure.cif")
format_report(qc)

# With CIF file for coverage and missing residue data
qc, structure = clean_structure("my_structure.pdb", cif_path="my_structure.cif")
format_report(qc)

# Keep ligands in cleaned structure
qc, structure = clean_structure("my_structure.pdb", keep_ligands=True)
format_report(qc)

CLI

pdbqc my_structure.pdb
pdbqc my_structure.pdb --cif my_structure.cif
pdbqc my_structure.pdb --keep-ligands

Output

╔══════════════════════════════════════╗ ║ Structure Quality Report ║ ╚══════════════════════════════════════╝ Atoms: 2671 Altlocs detected: none Insertion codes: none Microheterogeneity: none Chain Missing Residues Coverage ────────────────────────────────── A 15 90.5% B 13 91.8% C 0 100.0% D 0 100.0% MSE residues converted: none

What it checks

  • Alternate locations — counts atoms with altlocs before filtering; keeps highest occupancy
  • Insertion codes — detects and reports non-standard residue numbering
  • Microheterogeneity — flags residues with conflicting identities across altlocs
  • Missing residues — compares observed CA atoms to SEQRES (requires CIF)
  • Coverage — per-chain percentage of observed vs expected residues
  • MSE conversion — selenomethionine residues renamed to MET for standardized downstream use

Links

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

pdbqc-0.1.3.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

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

pdbqc-0.1.3-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file pdbqc-0.1.3.tar.gz.

File metadata

  • Download URL: pdbqc-0.1.3.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for pdbqc-0.1.3.tar.gz
Algorithm Hash digest
SHA256 08115b5426e097ca92163a1716fd7b0168085a020404ec597835657ca316da24
MD5 6b06f321ec0349006c303145bf1785b8
BLAKE2b-256 4dc17b6b0eef6dc9fa730dc6a601f1f64925896cd9bc6d78f817848af1f2eb11

See more details on using hashes here.

File details

Details for the file pdbqc-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: pdbqc-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for pdbqc-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e731d675b8533ab4433ddab2ba2c20144537ef43b5958545f5045e23365c359c
MD5 d57edb95aa07d7f8839e283abbe16fdb
BLAKE2b-256 9d5bffce0a7a3aeedc08f982cb7facdbd1bf7156a07904693c93284af0a20e17

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