v4.1.2

Fixed

• Prefer (faster) Genesis for model downloads, with a fall back to Zenodo
• CI: Update build runners for macOS (see actions/runner-images#13046)
• Fix logging for spectral library prediction (by @paretje in #257)

---

Full Changelog: v4.1.1...v4.1.2

v4.1.1

Fixed

• ⬆️ Fix support for sqlalchemy v2, keeping backwards compatibility with v1.4 (#249, fixes #250)
• 📝 Fix typo of max_length in search_space documentation (#245 by @paretje)
• 👷 In CI workflows, don't build dependencies like pyarrow from source. This can result in failed build workflows.

---

Full Changelog: v4.1.0...v4.1.1

v4.1.0

Added

• ✨ Support for Thermo raw (requiring dotnet runtime) and gzipped spectrum files, through mobiusklein/mzdata (#226, by @paretje)
• ✨ New Python API usage mode correlate-single to correlate to a single ObservedSpectrum object with predictions (#232)
• ✨ Added support for Python 3.12 and 3.13, Numpy v2, and newer Pandas and XGBoost versions (#228)
• ✅ CI: Add integration test for predict-single (#228)

Changed

• ⚠️ Ion mobility is now returned instead of collisional cross section when IM2Deep is used through the add_ion_mobility option (#236, by rodvrees)
• 🏗️ Model files are now downloaded from Zenodo instead of Genesis (#225, by paretje, fixes #229)
• 📝 Docs: Updated README to include correlate-single; moved webserver API docs from old Wiki (#239)

Removed

• 🐍 Removed support for Python 3.8 (EOL) and for musllinux distributions (#228, #237)
• 🗑️ Removed old conversion scripts, mostly implemented in psm_utils (#239)
• 🗑️ Removed old train script, to be replaced with page in docs (#239)

v4.0.0

Fully refactored and drastically more user-friendly version of MS²PIP:

• More modular Python API
• One consolidated command-line interface with subcommands
• Support for all file formats readable by psm_utils
• Support for MGF, mzML, and Bruker raw spectrum files
• Support for ProForma 2.0 peptide notation (no modification configuration required anymore)
• Support for multiple peptides/PSMs per spectrum
• Detailed documentation on ms2pip.readthedocs.io
• ...

v3.13.0

Added

• New timsTOF 2024 model added (now alias for timsTOF) by @ArthurDeclercq in #211

Full Changelog: v3.12.0...v3.13.0

v3.12.0

What's Changed

• Add code and figures for 2023 NAR manuscript @ArthurDeclercq in #196 and #197
• Backport timsTOF model from 4.0 dev release to 3.12 release by @RalfG in #206

Full Changelog: v3.11.0...v3.12.0

3.11.0

Added

• fasta2speclib: Improved workflow for generating spectral libraries starting from a FASTA file, with new configuration options. ⚠️ These changes break compatibility with the previous configuration files. ⚠️ (PR #193, fixes #188)
  • Support for C-terminal modifications
  • Differentiate between peptide and protein termini for variable modifications
  • Allow filtering of peptides based on precursor m/z
  • Allow semi-specific cleavage
  • Allow non-specific cleavage
  • Allow setting of a maximum of variable modifications per peptide
  • Add tests for modification assignment
• Add figures for 2023 manuscript (PR #194)

Changed

• Change logging of model configuration to debug level (PR #193)

Removed

• fasta2speclib: Removed support for Elude-based RT predictions, RT predictions file, PEPREC filter, saving temporary PEPREC files (PR #193)

Fixed

• Remove unsupported argument for mzml.read (PR #193)
• spectrum_output: Fix CSV output to always use \n line terminators (PR #193)
• spectrum_output: Use semi-colon for spectronaut CSV output (PR #193)
• DeepLC integration: Disable PyGAM for default calibration on iRT peptides (led to poor calibration) (PR #193)

v3.10.1

Added

• If the precursor charge is not found in the MGF file, the charge from the PeptideRecord file is used instead. (#189)
• Added tests for fasta2speclib modification generation. (#190)

Fixed

• Fixed issue in fasta2speclib where fixed modifications were added one residue to the left of the actual site. This bug was introduced in commit 6f41d44 and released in v3.10.0. (#190)

v3.10.0

Added

• Added support for mzML spectrum files (both for evaluating models and for extracting feature vectors).
• New argument spectrum_id_pattern: Regular expression pattern to apply to spectrum titles before matching to peptide file entries.
• When using MS²PIP as class instance, the resulting pred_and_emp dataframe can also be returned (instead of writing to a file) when setting return_results to True.
• If requested, retention time prediction with DeepLC is now also enabled if spectrum file is given. This feature was previously only enabled if only a peptide file was given.

Changed

• Improved logging: Use Rich library for logging, show time stamps and message log levels.
• MS²PIP now shows a progress bar instead of a wall of text to display prediction progress.
• fasta2speclib: Improved algorithm for variable modification assignment. Combinatorial explosion from variable modifications is now reduced by setting a maximum of modified residues per peptide, instead of arbitrarily selecting a maximum of potentially modified sites per peptide.
• Update README.md (Switch from BadGen to Shields.io).
• Switch to Pyteomics MGF reader.
• Avoid SciPy dependency.
• More optimal use of Numpy in calc_correlations.
• Remove poetry.lock (not used, avoid unneeded Dependabot PRs).

Fixed

• Vastly improved computational speed and reduced memory usage when using XGBoost model files for prediction in combination with providing a spectrum file (XGB prediction step is now moved out of multiprocessing).
• For optimal performance, feature vectors for predictions from XGBoost model files now also uses the traditional ms2pipC.py multiprocessing system.
• fasta2speclib: Fixed issue where modified versions of peptide were duplicated.
• spectrum_output: Various fixes in MSP spectral library file writing for DIA-NN compatibility: Write m/z error of 0.0 for each predicted peak in peak annotation string, ensure modifications in MSP Mods field are sorted by position, use RetentionTime instead of RTINSECONDS in comments field.
• Fixed double spectrum_utils entry in requirements.
• Updated python_requires to minimal 3.7, following previously updated test grid.
• Fix spectrum_utils modification off-by-one bug (had no consequences except for plot annotations).
  • Fixes #170
• Fix typo in write_amino_acid_masses function name.
• Fix missing comma in the setup.py.

Removed

• Removed unsupported Tableau output file option

v3.9.0

New and improved 🚀

• New prediction model for CID-TMT: TMT-labelled peptide spectra acquired on ion trap (trap-type CID), often used for "MultiNotch MS3" (https://dx.doi.org/10.1021/ac502040v) (PR #157)
• Support for Python 3.9 and 3.10; dropped support for end-of-life Python 3.6 (PR #156, fixes #126)
• Support for alternative cleavage rules (digestion enzymes) in fasta2speclib (PR #166, fixes #96)

Bugfixes 🐛

• Fixed missing support for XGBoost models in single-prediction mode (PR #157, fixes #155)
• Use oldest-supported-numpy for build in CI testing (PR #157)

Refactoring and minor changes 🔧

• Replaced C models files with their XGBoost counterpart (except for HCD2019 and TMT): Faster compilation, smaller Python package (PR #157)
• Add model_dir option to set custom directory for model downloads (CLI, single-prediction CLI, Python API) (PR #169, fixes #165)
• Add docstring to MS2PIP class and add example to README.md (PR #167, fixes #131)
• Relaxed click version requirements (PR #157, fixes #158)
• Removed XGBoost warnings from the CLI output (PR #157)
• Various fasta2speclib improvements (PR #166)
  • Add deeplc option to default config
  • Suppress tensorflow warnings
  • Replace deprecated pandas append with concat
• Add missing sptm and gptm to example config.toml (#167)

New prediction models

Model	Current version	Train-test dataset (unique peptides)	Evaluation dataset (unique peptides)	Median Pearson correlation on evaluation dataset
CID-TMT	v20220104	[in-house dataset] (72 138)	PXD005890 (69 768)	0.851085