Structure-based Antibody Renumbering
Project description
Structure-based Antibody Renumbering
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
- 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).
Alternatively, SAbR can be directly run with the latest docker container:
❌ This doesn't currently work. Please check back soon! ❌
docker run --rm ghcr.io/delalamo/sabr:latest -i input.pdb -o output.pdb -c CHAIN_ID
Running SAbR
If running on a Mac with apple silicon, set the environmental variable JAX_PLATFORMS to cpu.
usage: sabr [-h] -i INPUT_PDB -c INPUT_CHAIN -o OUTPUT_PDB [-n NUMBERING_SCHEME] [-t] [--overwrite] [-v]
Structure-based Antibody Renumbering (SAbR) renumbers antibody PDB files using the 3D coordinate of backbone atoms.
options:
-h, --help show this help message and exit
-i INPUT_PDB, --input_pdb INPUT_PDB
Input pdb file
-c INPUT_CHAIN, --input_chain INPUT_CHAIN
Input chain
-o OUTPUT_PDB, --output_pdb OUTPUT_PDB
Output pdb file
-n NUMBERING_SCHEME, --numbering_scheme NUMBERING_SCHEME
Numbering scheme, default is IMGT. Supports IMGT, Chothia, Kabat, Martin, AHo, and Wolfguy.
--overwrite Overwrite PDB
-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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sabr_kit-0.1.8.tar.gz.
File metadata
- Download URL: sabr_kit-0.1.8.tar.gz
- Upload date:
- Size: 2.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4bf2ce97958f891cb9eb136215ef0482d69bb2fd4f46ad1da185461f47dec0c5
|
|
| MD5 |
9c4052dc69d8ab5bc509d3da1300a003
|
|
| BLAKE2b-256 |
6b7660280b231308356ffb7dd5f8b1e6422f52f1d185cce43e8222d0e910477f
|
File details
Details for the file sabr_kit-0.1.8-py3-none-any.whl.
File metadata
- Download URL: sabr_kit-0.1.8-py3-none-any.whl
- Upload date:
- Size: 2.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0adafd3c38c290eaa864ccc4c81964bc9b8487eca541fa5dd555e79b1397475
|
|
| MD5 |
f2dd3f0be1038dceb7c1a02f183e1252
|
|
| BLAKE2b-256 |
dfeca69b15b9a9341a82c1abb4da1a8677bdf6a1ddf957b4ec4fb0e8b93c2246
|