Framework for prediction of collisional cross-section of peptides.
Project description
IM2Deep
Collisional cross-section prediction for (modified) peptides.
Introduction
IM2Deep is a deep learning-based CCS predictor for (modified) peptides. It accurately predicts collisional cross-section (CCS) values for modified peptides, even if the modification wasn't observed during training. The tool supports both single-conformer and multi-conformer predictions for peptide ions.
Installation
Install with pip:
pip install im2deep
For local development/docs:
uv sync --group dev --group docs
Usage
Command Line Interface (CLI)
Basic prediction:
im2deep <path/to/peptide_file.csv>
With calibration (HIGHLY recommended):
im2deep <path/to/peptide_file.csv> --calibration-precursors <path/to/calibration_file.csv>
Calibration options:
--calibrate-per-charge: Calculate separate calibration shift factors per charge state (recommended, default true)--use-charge-state: Charge state for global calibration when --calibrate-per-charge is disabled
Multi-conformer prediction: To use the multi-output prediction model (requires optional dependencies):
im2deep <path/to/peptide_file.csv> --calibration-precursors <path/to/calibration_file.csv> --multi
Output options:
im2deep <path/to/peptide_file.csv> --output-file predictions.csv
For a complete overview of all CLI arguments, run:
im2deep --help
Python API
IM2Deep can also be used programmatically:
from im2deep import predict, predict_and_calibrate
from psm_utils import PSMList
# Load your peptides as PSMList
psm_list = PSMList(psm_list=[...]) # or use psm_utils.io.read_file()
# Simple prediction
predictions = predict(psm_list)
# Prediction with calibration
psm_list_calibration = PSMList(psm_list=[...]) # Must contain CCS values
calibrated_predictions = predict_and_calibrate(
psm_list=psm_list,
psm_list_cal=psm_list_calibration
)
Input Files
Standard Format
IM2Deep accepts any format supported by psm_utils, including:
- Peptide Record (.peprec)
- MaxQuant msms.txt
- MSFragger PSM files
- And more...
Legacy CSV Format
Alternatively, use comma-separated values (CSV) with the following columns:
seq: Unmodified peptide sequencemodifications: Modifications listed aslocation|name, separated by pipe (|) characterslocation: Integer starting at 1 for the first amino acid0= N-terminal modification-1= C-terminal modification
name: Must correspond to a Unimod (PSI-MS) name
charge: Peptide precursor charge stateCCS: Collisional cross-section (only required for calibration files)
Example:
seq,modifications,charge,CCS
VVDDFADITTPLK,,2,422.9984309464991
GVEVLSLTPSFMDIPEK,12|Oxidation,2,464.6568644356109
SYSGREFDDLSPTEQK,,2,468.9863221739147
SYSQSILLDLTDNR,,2,460.9340710819608
DEELIHLDGK,,2,383.8693416055445
IPQEKCILQTDVK,5|Butyryl|6|Carbamidomethyl,3,516.2079366048176
Important Notes
- Calibration: Highly recommended for accurate predictions. Calibration corrects for systematic differences between predicted and observed CCS values.
- Charge states: IM2Deep predictions are reliable for charge states up to z=6. PSMs with higher charge states are automatically filtered out during validation.
Citing
If you use IM2Deep within the context of (TI)MS2Rescore, please cite the following:
TIMS²Rescore: A DDA-PASEF optimized data-driven rescoring pipeline based on MS²Rescore. Arthur Declercq*, Robbe Devreese*, Jonas Scheid, Caroline Jachmann, Tim Van Den Bossche, Annica Preikschat, David Gomez-Zepeda, Jeewan Babu Rijal, Aurélie Hirschler, Jonathan R Krieger, Tharan Srikumar, George Rosenberger, Dennis Trede, Christine Carapito, Stefan Tenzer, Juliane S Walz, Sven Degroeve, Robbin Bouwmeester, Lennart Martens, and Ralf Gabriels. Journal of Proteome Research (2025) doi:10.1021/acs.jproteome.4c00609
In other cases, please cite the following:
Collisional cross-section prediction for multiconformational peptide ions with IM2Deep. Robbe Devreese, Alireza Nameni, Arthur Declercq, Emmy Terryn, Ralf Gabriels, Francis Impens, Kris Gevaert, Lennart Martens, Robbin Bouwmeester. Anal. Chem. (2025) doi:10.1021/acs.analchem.5c01142
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 im2deep-2.0.0a2.tar.gz.
File metadata
- Download URL: im2deep-2.0.0a2.tar.gz
- Upload date:
- Size: 70.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d6cf032ff4a945d3f424e0ffd931182d7642c725d1fd0e8f629518a65960174
|
|
| MD5 |
a9ee8e4d2910380fcaa0a7019b1ae9a4
|
|
| BLAKE2b-256 |
fb92aa8243a7ff9caba73fba26917706ad8bf864dcbdd14b91735b45cf244831
|
Provenance
The following attestation bundles were made for im2deep-2.0.0a2.tar.gz:
Publisher:
publish.yml on CompOmics/IM2Deep
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
im2deep-2.0.0a2.tar.gz -
Subject digest:
8d6cf032ff4a945d3f424e0ffd931182d7642c725d1fd0e8f629518a65960174 - Sigstore transparency entry: 1254724619
- Sigstore integration time:
-
Permalink:
CompOmics/IM2Deep@8fc2fb4f9c0767736fc2824f3e09a007ef4d7021 -
Branch / Tag:
refs/tags/v2.0.0-alpha.2 - Owner: https://github.com/CompOmics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@8fc2fb4f9c0767736fc2824f3e09a007ef4d7021 -
Trigger Event:
release
-
Statement type:
File details
Details for the file im2deep-2.0.0a2-py3-none-any.whl.
File metadata
- Download URL: im2deep-2.0.0a2-py3-none-any.whl
- Upload date:
- Size: 70.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9c5340eeaa3850c0dd0736902581f64df24876bc147252100eb06aeb4ed68798
|
|
| MD5 |
86d6c4a3406e6f77faacedc55eb326c0
|
|
| BLAKE2b-256 |
19f034f26e6ad287e95a625e11fd4224aad554e660a84bda4635bff253466d2a
|
Provenance
The following attestation bundles were made for im2deep-2.0.0a2-py3-none-any.whl:
Publisher:
publish.yml on CompOmics/IM2Deep
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
im2deep-2.0.0a2-py3-none-any.whl -
Subject digest:
9c5340eeaa3850c0dd0736902581f64df24876bc147252100eb06aeb4ed68798 - Sigstore transparency entry: 1254724691
- Sigstore integration time:
-
Permalink:
CompOmics/IM2Deep@8fc2fb4f9c0767736fc2824f3e09a007ef4d7021 -
Branch / Tag:
refs/tags/v2.0.0-alpha.2 - Owner: https://github.com/CompOmics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@8fc2fb4f9c0767736fc2824f3e09a007ef4d7021 -
Trigger Event:
release
-
Statement type: