Skip to main content

alpha_fold_viewer

AF3 ZIP → Standalone HTML Report — a single-file tool that converts AlphaFold3 output ZIP files into beautiful, self-contained HTML reports.

What it does

Takes an AlphaFold3 prediction ZIP file and produces a single HTML file containing:

  • Input summary — sequences in FASTA format with copy buttons, chain types, lengths
  • Confidence overview — all models ranked by ranking_score with ipTM, pTM, fraction disordered, clash status
  • Chain sequences — full sequences with per-residue pLDDT coloring and interface residue highlighting
  • Sequence heatmap strips — linear pLDDT bars with interface position markers
  • PAE heatmaps — full predicted aligned error matrices with chain boundaries (embedded as base64 images)
  • Interface analysis — inter-chain contacts with residue counts, mean PAE, pLDDT, and high-confidence percentages
  • Per-model details — collapsible sections with chain info and interface residue ranges

The HTML is fully standalone — all images are embedded as data URIs, CSS is inline, no external dependencies. Open it in any browser, share via email, or include in presentations.

Works with any AlphaFold3 output: protein homodimers, heterodimers, protein+DNA complexes, multi-chain assemblies.

PAE Heatmap (CTCF protein + DNA complex, 3 chains)

PAE Heatmap

Interface PAE Sub-matrix

Interface PAE

Sequence Strip with pLDDT and Interface Markers

Sequence Strip

Colored Sequence with Interface Residues

Colored Sequence

Installation

From PyPI

pip install alpha-fold-viewer

From source

git clone https://github.com/aglabx/alpha_fold_viewer.git
cd alpha_fold_viewer
pip install .

Requirements: Python 3.8+, numpy, scipy, matplotlib.

Usage

# Basic usage — generates fold_ctcf_report.html
af3-report fold_ctcf_dimer.zip

# Custom output path
af3-report fold_ctcf_dimer.zip -o ctcf_report.html

# Stricter contact distance (default: 8.0 Å)
af3-report fold_ctcf_dimer.zip --contact-dist 6.0

# Keep extracted temp files for debugging
af3-report fold_ctcf_dimer.zip --keep-tmp

# Also works as a Python script
python af3_report.py fold_ctcf_dimer.zip

CLI Reference

af3-report INPUT_ZIP [-o OUTPUT_HTML] [--contact-dist 8.0] [--keep-tmp]

Positional:
  INPUT_ZIP          Path to AlphaFold3 output ZIP file

Options:
  -o, --output       Output HTML file (default: {zip_name}_report.html)
  --contact-dist     Inter-atomic contact threshold in Å (default: 8.0)
  --keep-tmp         Keep extracted temporary files

Output Description

Confidence Overview

Models are sorted by ranking_score (highest first). The best model is highlighted in green. Columns:

Column Description
Ranking Score AF3 composite confidence metric (higher = better)
ipTM Interface predicted TM-score (0–1, higher = better interface)
pTM Predicted TM-score for overall structure
Frac. Disordered Fraction of residues predicted as disordered
Clash Whether the model has steric clashes

Chain Sequences

Each chain is displayed with:

  • Full sequence colored by per-residue pLDDT (green ≥90, cyan ≥70, yellow ≥50, red <50)
  • Interface residues highlighted with cyan background
  • Linear heatmap strip showing pLDDT along the sequence with interface markers

Interface Analysis

For multi-chain models, inter-chain contacts are detected using a KDTree spatial search. Each interface reports:

Metric Description
Res. A / Res. B Number of residues at the interface per chain
Atom Contacts Total inter-chain atom pairs within contact distance
pLDDT A / pLDDT B Mean predicted local confidence at interface residues
Avg PAE Mean predicted aligned error across interface residue pairs
PAE <10Å Percentage of PAE values below 10Å (higher = more confident)
High-conf Percentage of contacts where both atoms have pLDDT ≥ 70

PAE Heatmaps

Each model gets a full PAE matrix heatmap with chain boundary lines. The colormap runs from dark blue (low PAE = high confidence) through green/yellow to red (high PAE = low confidence). Scale: 0–30 Å.

For multi-chain models, per-interface sub-matrices are also shown with mean PAE and <10Å percentage annotations.

How it works

  1. Extracts the AF3 ZIP to a temporary directory
  2. Auto-discovers model files (*_model_*.cif, *_full_data_*.json, *_summary_confidences_*.json)
  3. Parses mmCIF structures to extract atom coordinates, chain IDs, pLDDT values
  4. Loads PAE matrices from full_data JSONs
  5. Detects inter-chain interfaces using scipy KDTree
  6. Cross-references interfaces with PAE data
  7. Generates PAE heatmaps in-memory using matplotlib (→ base64 PNGs)
  8. Assembles everything into a single standalone HTML file

License

MIT

Metadata

Release files for alpha-fold-viewer 0.1.5

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

Source distribution (sdist)

Source distribution for alpha-fold-viewer 0.1.5
File Size Uploaded Provenance
alpha_fold_viewer-0.1.5.tar.gz 19.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for alpha-fold-viewer 0.1.5
File Interpreter ABI Platform
alpha_fold_viewer-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 38.0 kB

Release files / alpha_fold_viewer-0.1.5.tar.gz

Download URL alpha_fold_viewer-0.1.5.tar.gz
Size 19.9 kB
Tags Source
SHA-256 checksum
How to use checksums
23fcd9e30e2f20d2947d0f4b9344c723b564544be50c017789db7d8c9fcd13b8
BLAKE2b-256 checksum
How to use checksums
6a5d03af88bf0638a2c3857e905e45d24f0b0cf47bbeed8632d7542f04a268bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.12

Release files / alpha_fold_viewer-0.1.5-py3-none-any.whl

Download URL alpha_fold_viewer-0.1.5-py3-none-any.whl
Size 18.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ac4ca9423bd6742264f9c3f3f2191d5ce8192c1d1f70c339bc6cbcb56bb5b764
BLAKE2b-256 checksum
How to use checksums
22cd24f49831af61ba8d50f9e2dd3983fe986a31de8f8985f09df8b89472c718
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.12

Security for alpha-fold-viewer 0.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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