Skip to main content

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

Project description

Release License Tests Deployment Coverage


preview

Table of Contents

  1. Installation
  2. Getting started

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.

  • Library and CLI installation: Choose this installation if you want to use alphaDIA as a library or its command-line interface. You need to be familiar with CLI tools, Conda and Python. It allows access to all available features of alphaDIA.

  • 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.

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 and mono to be installed. Save the installer and open the parent folder in Finder. Right-click and select open. If you receive a warning during installation click Open.

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

Library and CLI 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. This is currently also the preferred way for Linux users that do not need the GUI.

1. Prerequisites

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

Setting up mono [MacOS/Linux only]

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 conda virtual environment, as otherwise dependancy conflicts can occur with already existing packages.

conda create --name alphadia python=3.9 -y
conda activate alphadia

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.6.2.tar.gz (194.5 kB view details)

Uploaded Source

Built Distribution

alphaDIA-1.6.2-py3-none-any.whl (207.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: alphadia-1.6.2.tar.gz
  • Upload date:
  • Size: 194.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for alphadia-1.6.2.tar.gz
Algorithm Hash digest
SHA256 328c10ed32078054a2da2879a12ff13db55b885775802724f7ca7deebe3b610d
MD5 3308f6ad557e154f03690208870ab8b5
BLAKE2b-256 b224e4fe0678139639eb49189ed06d6bc77c1794e87c72a5ea8ec5a19a55ac5f

See more details on using hashes here.

Provenance

File details

Details for the file alphaDIA-1.6.2-py3-none-any.whl.

File metadata

  • Download URL: alphaDIA-1.6.2-py3-none-any.whl
  • Upload date:
  • Size: 207.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for alphaDIA-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 20f0d028a8ee0136a5474acfacf0f924e34ada95b5ef1f063706c2c45b5ce05f
MD5 4928d1573c6df913886a3532cc8508b5
BLAKE2b-256 3345713600824b4fcc4a2c5f7c3dec4cb9db0dae27c7d3f1164e50f4880c9111

See more details on using hashes here.

Provenance

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