Skip to main content

pyXLMS

a python package to process protein cross-linking data

pyXLMS is a python package and web application with graphical user interface that aims to simplify and streamline the intermediate step of connecting crosslink search engine results with down-stream analysis tools, enabling researchers even without bioinformatics knowledge to conduct in-depth crosslink analyses and shifting the focus from data transformation to data interpretation and therefore gaining biological insight. Currently pyXLMS supports input from several different crosslink search engines including: MaxLynx (part of MaxQuant), MeroX, MS Annika, pLink 2 and pLink 3, Scout, xiSearch and xiFDR, XlinkX, as well as the mzIdentML format of the HUPO Proteomics Standards Initiative, and a well-documented and human-readable custom tabular format. Down-stream analysis is facilitated by functionality that is directly available within pyXLMS such as validation, annotation, aggregation, filtering, and visualization - and much more - of crosslink-spectrum-matches and crosslinks. In addition, the data can easily be exported to the required data format of the various available down-stream analysis tools such as AlphaLink2, ProXL, xiNET, xiVIEW, xiFDR, XlinkDB, xlms-tools, PyMOL (via PyXlinkViewer), ChimeraX (via XMAS), or IMP-X-FDR.

Installation

pyXLMS supports python version 3.7 and greater!

pyXLMS can easily be installed via pip:

pip install pyxlms

Quick Start

After installation you can use pyXLMS in python like this:

This example shows reading of MS Annika crosslink-spectrum-matches and exporting them to xiFDR format for external validation.

>>> import pyXLMS
>>> pr = pyXLMS.parser.read(
...     "data/ms_annika/XLpeplib_Beveridge_QEx-HFX_DSS_R1_CSMs.xlsx",
...     engine="MS Annika",
...     crosslinker="DSS"
... )
Reading MS Annika CSMs...: 100%|████████████████| 826/826 [00:00<00:00, 20731.70it/s]
>>> _ = pyXLMS.transform.summary(pr)
Number of CSMs: 826.0
Number of unique CSMs: 826.0
Number of intra CSMs: 803.0
Number of inter CSMs: 23.0
Number of target-target CSMs: 786.0
Number of target-decoy CSMs: 39.0
Number of decoy-decoy CSMs: 1.0
Minimum CSM score: 1.11
Maximum CSM score: 452.99
>>> _ = pyXLMS.exporter.to_xifdr(
...     pr["crosslink-spectrum-matches"],
...     filename="msannika_CSMs_for_xiFDR.csv"
... )

For python projects using pyXLMS we also provide a project template!

Web App

The web app is publicly accessible for free via hgb-bin-proteomics.github.io/pyXLMS-app.

Additionally, it can be run locally or self-hosted as described here: pyXLMS Web Application.

User Guide, Examples and Documentation

FAQ

Not sure if pyXLMS is what you are looking for? You can find a collection of common questions and answers about pyXLMS here or in the user guide under Documentation ➡️ FAQ.

Limitations

Despite our best efforts pyXLMS still comes with some limitations that are a direct result of the differences in the output formats of crosslink search engines. Many crosslink search engines do not report any kind of decoy matches which makes validation in pyXLMS or export to xiFDR impossible which is why we recommend using validated results for pyXLMS. Validation within pyXLMS is currently only supported for MaxLynx, MS Annika, and xiSearch.

Furthermore, the different down-stream analysis tools require varying input information which might not be consistently available from all crosslink search engines. Some of this can be mitigated by functionality in pyXLMS such as annotation or by additional information that needs to be passed to pyXLMS for a successful export. Generally, the export to all downstream analysis tools should work for all crosslink search engines and input formats, with the exception of the export to xiFDR which is limited to MaxLynx, MS Annika, and xiSearch for above reasons. For safety pyXLMS makes sure before the export that all the required information is available and will otherwise throw an error. For more information please check the specific export pages in the user guide and the documentation.

The web app supports most of the features of the python package, features that are not supported in the web app are listed in the user guide under Documentation ➡️ Web Application ➡️ Feature Support.

Interacting with STRING requires an active internet connection and depends on the service availability of STRING.

Citing

If you are using pyXLMS please cite the following publication:

  • Manuscript in preparation
    (wip)
    

Acknowledgements

We thank Melanie Birklbauer for designing the logo.

Contact

Metadata

Release files for pyXLMS 2.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyXLMS 2.0.7
File Size Uploaded Provenance Actions
pyxlms-2.0.7.tar.gz 216.0 kB With provenance Details for pyxlms-2.0.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyXLMS 2.0.7
File Interpreter ABI Platform Actions
pyxlms-2.0.7-py3-none-any.whl Python 3 none any Details for pyxlms-2.0.7-py3-none-any.whl

Total release size: 416.1 kB

Release files / pyxlms-2.0.7.tar.gz

Download URL pyxlms-2.0.7.tar.gz
Size 216.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a09db663810c4054ac29c6ee9bdbf749b198545baf25e05126c5a79219b71e22
BLAKE2b-256 checksum
How to use checksums
71852a187a93944dfc8811982f8ac20c1a79fabd8c99d57523e54e1ed1360e99
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / pyxlms-2.0.7-py3-none-any.whl

Download URL pyxlms-2.0.7-py3-none-any.whl
Size 200.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
45bd13f606265744a481257eadfa78c3a7ae899c24b0c83ec98a73da195f5dbc
BLAKE2b-256 checksum
How to use checksums
b6f7b3353375613462565877ddcb77b0bd043b06f67af4a292dbc27967118935
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Security for pyXLMS 2.0.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pyxlms-2.0.7.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.0.7 This release

2 release files Full provenance

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