Skip to main content

MHCXGraph

A Python package for detecting potential T cell receptor cross-reactivity based on peptide–MHC structures.

MHCXGraph leverages graph-based approaches to identify conserved exposed regions across multiple pMHC structures. It supports multiple execution modes and offers fully adjustable parameters, enabling flexible configuration to suit diverse user needs. For result analysis, the package provides an interactive dashboard that facilitates data exploration through graph visualizations and projections onto 3D structures

See also:

Installation

From PyPI (stable): To install the latest release on PyPI, run:

pip install MHCXGraph

From source (development):

git clone https://github.com/cnpem/MHCXGraph.git
pip install -e MHCXGraph

Quick Start

MHCXGraph is configured via a JSON manifest file. Download and extract the examples package:

Linux / macOS

wget https://github.com/cnpem/MHCXGraph/releases/download/0.1.2/examples.tar.gz
tar -xzf examples.tar.gz

Windows (PowerShell)

Invoke-WebRequest -Uri https://github.com/cnpem/MHCXGraph/releases/download/0.1.2/examples.zip -OutFile examples.zip
Expand-Archive examples.zip

Or download directly: Linux/macOS (.tar.gz) · Windows (.zip)

The example manifest is at examples/manifests/manifest-minimal.json. To run it:

MHCXGraph run examples/manifests/manifest-minimal.json

A basic manifest has the following structure:

{
  "settings": {
    "run_name": "my-run",
    "run_mode": "multiple",
    "output_path": "path/to/output/",
    "edge_threshold": 8.5,
    "node_granularity": "all_atoms",
    "triad_rsa": false,
    "rsa_filter": 0.1,
    "global_distance_diff_threshold":2.0,
    "local_distance_diff_threshold":1.0,
    "distance_bin_width": 2,
  },
  "inputs": [
    {
      "path": "path/to/input",
      "extensions": [".pdb", ".cif"],
      "selectors": [{ "name": "MHC1" }]
    }
  ],
  "selectors": {
    "MHC1": {
      "chains": ["C"],
      "structures": {},
      "residues": {
        "A": [18,19,42,43,44,54,55,56,58,59,61,62,63,64,65,66,68,69,70,71,72,73,75,76,79,
            80,83,84,89,108,109,142,143,145,146,147,148,149,150,151,152,153,154,155,156,
            157,158,159,161,162,163,165,166,167,169,170,171]
      }
    },
    ,
    "MHC2": {
      "chains": ["C"],
      "residues": {
        "A": [37,51,52,53,55,56,58,59,60,62,63,65,66,67,69],
        "B": [56,57,59,60,61,62,63,65,66,67,68,69,70,71,72,73,74,77,78,81]
      }
    },
    "general": {
	    "chains" : ["C"],
	    "structures" : ["helix"],
	    "residues" : {}
    }
  }
}

[!WARNING] Input structures in this example have been pre-processed with MHCXGraph renumber. This step must be executed before graph analysis whenever residue selectors targeting TCR-contacting positions are used.

Key Configuration Parameters¹

Category Parameter Description Default
Execution run_name Name of the run test
run_mode Execution mode: pairwise, multiple, or screening multiple
output_path Path for results output ./outputs
reference_structure Path to reference structure (required for screening mode) None
Graph node_granularity Atomic representation for residue nodes: ca_only, all_atoms, backbone, or sidechain all_atoms
edge_threshold Distance cutoff (Å) for defining edges between nodes 8.5
include_ligands Include ligands as graph nodes true
include_noncanonical_residues Include modified amino acids as nodes true
include_waters Include water molecules as nodes true
filter_triads_by_chain Restrict triads to those with at least one node from the specified chain None
max_gap_helix Max residue gap between helices to treat them as continuous 0
Triad comparison distance_bin_width Width of distance bins for discretization 2.0
local_distance_diff_threshold Max distance difference (d1/d2/d3) between triads for association 1.0
global_distance_diff_threshold Max distance difference between non-adjacent nodes across structures (frame generation step) 2.0
close_tolerance Tolerance for placing distances at bin center 0.1
Surface representation rsa_filter Min RSA for canonical residues to be included as nodes 0.1
asa_filter Min ASA for non-canonical residues, waters, and ligands 5
RSA tokens ² triad_rsa Use RSA values in triad token representation false
rsa_bin_width Width of RSA bins for discretization 0.3
rsa_diff_threshold Max RSA difference between triad nodes for association 0.3
close_tolerance_rsa Tolerance for placing RSA values at bin center 0.01

¹ A complete description of all parameters can be found in the documentation

² RSA token parameters are only active when triad_rsa: true.

Selectors

Selectors define which residues and chains are included as graph nodes. They can be specified by chain ID, residue index, or secondary structure type (helix, etc.), and referenced by name in the inputs block.

Citation

Santos Simões, C. D. M., Riveros Maidana, R. L. B., de Assis, S. C., Guerra, J. V. S., & Ribeiro-Filho, H. V. (2026). MHCXGraph: A Graph-Based approach to detecting T cell receptor cross-reactivity. https://doi.org/10.64898/2026.04.07.717034

License

The software is licensed under the terms of the GNU Affero General Public License 3 (AGPL3) and is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

Download files

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

Source Distribution

mhcxgraph-0.1.3.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

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

mhcxgraph-0.1.3-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mhcxgraph-0.1.3.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mhcxgraph-0.1.3.tar.gz
Algorithm Hash digest
SHA256 f0be9c984cf983c40c681efa5f7b476471d4ec8a50d1e2053a5c1c513ec858c6
MD5 0842241f73ba8e478b15b55b0dc4c23c
BLAKE2b-256 b2dc8cb25bc8ce7a2a4617501c629c3f4697f0e7c11761c2013244f5ae3dc01c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mhcxgraph-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mhcxgraph-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e8496c5edf013a04a107ec1c5b7bc8588aa6f5c0cd8e73c849dd7e505d00cfe2
MD5 1f9ee0935786decfd79a211dd2ca3513
BLAKE2b-256 c97435361eea8818d4d3f67b8189a4e0d94a1afe98c465194b88ddeb787b16e3

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 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