Skip to main content

Structure-based Antibody Renumbering

Project description

Structure-based Antibody Renumbering

Tests Code Formatting PyPI version Python 3.11+ License: MIT

This repo is currently in development. If you encounter any bugs, please report the issue here.

SAbR (Structure-based Antibody Renumbering) renumbers antibody PDB files using the 3D coordinate of backbone atoms. It uses custom forked versions of SoftAlign and ANARCI to align structures to SAbDaB-derived consensus embeddings and renumber to various antibody schemes, respectively.

Installation and use

Requirements: Python 3.11 or higher

  1. SAbR can be installed into a virtual environment via pip:
# Latest release
pip install sabr-kit

# Most recent version from Github
git clone --recursive https://github.com/delalamo/SAbR.git
cd SAbR/
pip install -e .

It can then be run using the sabr command (see below).

  1. Alternatively, SAbR can be directly run with the latest docker container:
docker run --rm ghcr.io/delalamo/sabr:latest -i input.pdb -o output.pdb -c CHAIN_ID

Running SAbR

Practical considerations:

  • Heavy and light chain structures are similar enough that chain type should be manually declared with --chain-type if possible (leave blank if uncertain).
  • It is recommended for now to truncate the query structure to contain only the Fv when running SAbR, as it will sometimes align variable region beta-strands to those in the constant region.
  • When running scFvs, it is recommended to run each variable domain independently.

If running on a Mac with apple silicon, set the environmental variable JAX_PLATFORMS to cpu.

Usage: sabr [OPTIONS]

  Structure-based Antibody Renumbering (SAbR) renumbers antibody PDB files
  using the 3D coordinates of backbone atoms.

Options:
  -i, --input-pdb FILE            Input PDB file.  [required]
  -c, --input-chain TEXT          Chain identifier to renumber.
  -o, --output FILE               Destination structure file. Use .pdb
                                  extension for PDB format or .cif extension
                                  for mmCIF format. mmCIF is required when
                                  using --extended-insertions.  [required]
  -n, --numbering-scheme [imgt|chothia|kabat|martin|aho|wolfguy]
                                  Numbering scheme.  [default: (IMGT)]
  --overwrite                     Overwrite the output PDB if it already
                                  exists.
  -v, --verbose                   Enable verbose logging.
  --max-residues INTEGER          Maximum number of residues to process from
                                  the chain. If 0 (default), process all
                                  residues.
  -t, --chain-type [heavy|light|auto]
                                  Restrict alignment to specific chain type
                                  embeddings. 'heavy' searches only heavy
                                  chain (H) embeddings, 'light' searches only
                                  light chain (K and L) embeddings, 'auto'
                                  searches all embeddings and picks the best
                                  match.  [default: auto]
  --extended-insertions           Enable extended insertion codes (AA, AB,
                                  ..., ZZ, AAA, etc.) for antibodies with very
                                  long CDR loops. Requires mmCIF output format
                                  (.cif extension). Standard PDB format only
                                  supports single-character insertion codes
                                  (A-Z, max 26 insertions per position)
  -v, --verbose         Verbose output

Known issues

  • SAbR currently struggles with scFvs for two reasons. First, it is unclear how to assign canonical numbering to multiple domains within a single chain, unless we accept a spacer (e.g., starting chain #2 at 201 instead of 1). Second, it will sometimes align across both chains, introducing a massive insertion in between. It is unclear how to prevent this; please see issue #2 for details.
  • SAbR sometimes mistakenly includes sheets from the Fab in the VH.
  • The algorithm for renumbering CDRs, which is the same as the one for IMGT, does not account for unassigned residues. So if a residue is missing due to heterogeneity, the CDR numbering algorithm will misnumber other residues in the CDR.

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

sabr_kit-0.2.5.tar.gz (27.2 MB view details)

Uploaded Source

Built Distribution

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

sabr_kit-0.2.5-py3-none-any.whl (27.2 MB view details)

Uploaded Python 3

File details

Details for the file sabr_kit-0.2.5.tar.gz.

File metadata

  • Download URL: sabr_kit-0.2.5.tar.gz
  • Upload date:
  • Size: 27.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sabr_kit-0.2.5.tar.gz
Algorithm Hash digest
SHA256 09de69f31915f0400445e29b3489531a67023cc04c4b8d2c4d04e24c8793c250
MD5 5de1fb53fc2701fa4c61cc5573dbe6ac
BLAKE2b-256 2376a9cad0c181087b72154f1216b6bcee3db7d0ac8aba215488c60ec22ae418

See more details on using hashes here.

File details

Details for the file sabr_kit-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: sabr_kit-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 27.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sabr_kit-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ccd87a6c9f4ce33ea88f3466ee3c0863e407002769eb03d4d0ddeb4b17c23aa8
MD5 0c474bdf70009a5a02dacb9417d4138e
BLAKE2b-256 5d9886cb289b683a24ebfe4aaefee86f5dc610165b1930bde6692da8db1a5c21

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