Skip to main content

A novel proteomics search engine for DIA data based on end-to-end transfer learning.

Project description

GitHub Release Versions License GitHub Actions Workflow Status GitHub Actions Workflow Status Docs GitHub Actions Workflow Status GitHub Actions Workflow Status Coverage


preview

Features

  • Empirical library and fully predicted library search
  • End-to-end transfer learning for custom RT, mobility, and MS2 models
  • Label free quantification
  • DIA multiplexing

We support the following vendor and processing modes:

Platform Empirical lib Predicted lib
Thermo .raw
Sciex .wiff
Bruker .d ⚠️

⚠️ Predicted libraries with Bruker .d data
Alltough search is possible, alphaDIA's feature-free search takes a long time with fully predicted libraries. We are still evaluating how to better support fully predicted libraries.

Manuscript

Please cite:

AlphaDIA enables End-to-End Transfer Learning for Feature-Free Proteomics
Georg Wallmann, Patricia Skowronek, Vincenth Brennsteiner, Mikhail Lebedev, Marvin Thielert, Sophia Steigerwald, Mohamed Kotb, Tim Heymann, Xie-Xuan Zhou, Magnus Schwörer, Maximilian T. Strauss, Constantin Ammar, Sander Willems, Wen-Feng Zeng, Matthias Mann
biorxiv.org

alphaDIA is part of the alphaX ecosystem:

Installation

AlphaDIA can be installed on Windows, macOS and Linux. Please choose the preferred installation:

  • One-click GUI installation: Choose this installation if you only want the GUI and/or keep things as simple as possible.

  • Pip installationThis version allows you to use alphaDIA in your python environment (provided e.g. by conda). You will only have access to the search engine backend and the command line but not the GUI.

  • Developer installation: This installation allows to modify alphaDIA's source code directly. Generally, the developer version of alphaDIA outperforms the precompiled versions which makes this the installation of choice for high-throughput experiments.

  • Docker installation: Choose this for running alphaDIA in a Docker container, which is useful if you want to run it in a cloud environment.

  • Slurm installation: Choose this for running alphaDIA on a research cluster with Slurm.

One-click GUI installation

Currently available for MacOS and Windows. You can download the latest release of alphaDIA here.

  • Windows: Download the latest win-x64 build. Save it and double click it to install. If you receive a warning during installation click Run anyway.
  • MacOS: Download the latest darwin-arm64 build. Please note that alphaDIA currently requires an ARM based M1/2/3 processor for the one-click installer. Save the installer and open the parent folder in Finder. Right-click and select open. If you receive a warning during installation click Open. If you want to use .raw files on Thermo instruments alphaRaw is required, which depends on Mono. A detailed guide to installing alphaRaw with mono can be found here.

As of now, Linux users need follow the steps for the developer installation in order to use the GUI.

Pip installation

If you want to use alphaDIA as a python library (e.g. for importing it into Jupyter notebooks) or only use the command-line interface, you can install alphaDIA via pip.

1. Prerequisites

Please make sure you have a valid installation of conda or miniconda. We recommend setting up miniconda as described on their website.

If you want to use .raw files on Thermo instruments alphaRaw is required, which depends on Mono. A detailed guide to installing alphaRaw with mono can be found here.

2. Setting up the environment

For any Python package, it is highly recommended to use a separate, as otherwise dependancy conflicts can occur with already existing packages. We generally recommend miniconda.

Finally, alphaDIA and all its dependencies can be installed by

pip install "alphadia[stable]"

We strongly recommend using the stable version, which has all dependencies fixed, for reasons of reproducibility and integrity.

Alternatively, use pip install alphadia, which comes with less version constraints. This is not recommended, but may be useful to avoid version clashes if alphaDIA is imported as a library into a defined python requirement. Note however, that this "loose" version might be affected e.g. by breaking changes of third-party dependencies.

Finally, run alphadia -v to check if the installation was successful; alphadia -h will give you a list of command-line options.


Getting started

This guide will show you how to perform your first search using the One-click GUI.

1. Prerequisites

Make sure you have installed the GUI using the one-click installer. To verify your installation, open alphaDIA and make sure that the BundledExecutionEngine is selected.

Logo

2. Test data

For the first search we will be using a spectral library to search 60SPD bulk HeLa samples on the Orbitrap Astral. Download the test samples and save them: HeLa library, [RAW files].(https://datashare.biochem.mpg.de/s/339jg5HtGrwLwDN)

3. Search settings

Input Files

Import the library .hdf file and select the thre .raw files. You can select a human .fasta file for reannotation but it's generally not recommended for empirical spectral libraries.

Method Settings

Although alphaDIA is highly customizable, we will only specify a limited number of settings here. Go to the Search settings and make the following changes:

  • Number of candidates: 5
  • MS1 Tolerance 4ppm
  • MS2 Tolerance 7ppm

Output files

Select an output folder where the search progress and the final results should be saved.

4. Run the search

Click Run Workflow to start the search and see the progress.


Troubleshooting

In case of issues, check out the following:

  • Issues: Try a few different search terms to find out if a similar problem has been encountered before
  • Discussions: Check if your problem or feature requests has been discussed before.

Citations

A manuscript has been submitted to bioRxiv.


How to contribute

If you like this software, you can give us a star to boost our visibility! All direct contributions are also welcome. Feel free to post a new issue or clone the repository and create a pull request with a new branch. For an even more interactive participation, check out the discussions and the the Contributors License Agreement.

Further information on the development process can be found here.


Changelog

See the HISTORY.md for a full overview of the changes made in each version.


About

An open-source Python package of the AlphaPept ecosystem from the Mann Labs at the Max Planck Institute of Biochemistry.


License

AlphaDIA was developed by the Mann Labs at the Max Planck Institute of Biochemistry and is freely available with an Apache License. External Python packages (available in the requirements folder) have their own licenses, which can be consulted on their respective websites.


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

alphadia-1.8.2.tar.gz (217.8 kB view details)

Uploaded Source

Built Distribution

alphadia-1.8.2-py3-none-any.whl (228.6 kB view details)

Uploaded Python 3

File details

Details for the file alphadia-1.8.2.tar.gz.

File metadata

  • Download URL: alphadia-1.8.2.tar.gz
  • Upload date:
  • Size: 217.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for alphadia-1.8.2.tar.gz
Algorithm Hash digest
SHA256 44091c8ffae320cea60b02a9dcbaf4cc184b795eb7447deb460ae80d524fcb9e
MD5 61608db475f7f9b51b3a78746a944030
BLAKE2b-256 0e20a0ee167d46f1aab5aeb4ba2b24e0efe9ed0f1e7b7bb57f12be1ccebf29c3

See more details on using hashes here.

File details

Details for the file alphadia-1.8.2-py3-none-any.whl.

File metadata

  • Download URL: alphadia-1.8.2-py3-none-any.whl
  • Upload date:
  • Size: 228.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for alphadia-1.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6e1e8c9a7551dfee79a7dd8fdf66a66b89886722a58b45fc2d57caf8d30f1614
MD5 6cc2f47cdd70e25f3c1e1cd40ace8ce2
BLAKE2b-256 d49ad3b12c5fa9d55155abc6aaca5e540e9f4ddaf54c3e4a1e2ac7ee881198f7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page