# AlphaBase
[](https://alphabase.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/alphabase)
[](https://pypi.org/project/alphabase)
AlphaBase provides all basic python functionalities for AlphaPept
ecosystem from the [Mann Labs at the Max Planck Institute of
Biochemistry](https://www.biochem.mpg.de/mann) and the [University of
Copenhagen](https://www.cpr.ku.dk/research/proteomics/mann/). To enable
all hyperlinks in this document, please view it at
[GitHub](https://github.com/MannLabs/alphabase). For documentation,
please see [readthedocs](https://alphabase.readthedocs.io/en/latest).
- [**About**](#about)
- [**License**](#license)
- [**Installation**](#installation)
- [**Pip installer**](#pip)
- [**Developer installer**](#developer)
- [**Usage**](#usage)
- [**Troubleshooting**](#troubleshooting)
- [**Citations**](#citations)
- [**How to contribute**](#how-to-contribute)
- [**Changelog**](#changelog)
------------------------------------------------------------------------
## About
The infrastructure package of AlphaX ecosystem for MS proteomics. It was first published with AlphaPeptDeep, see [Citations](#citations).
### Packages built upon AlphaBase
- [AlphaPeptDeep](https://github.com/MannLabs/alphapeptdeep): deep learning framework for proteomics.
- [AlphaRaw](https://github.com/MannLabs/alpharaw): raw data reader for different vendors.
- [AlphaDIA](https://github.com/MannLabs/alphadia): DIA search engine.
- [PeptDeep-HLA](https://github.com/MannLabs/peptdeep-hla): personalized HLA-binding peptide prediction.
- [AlphaViz](https://github.com/MannLabs/alphaviz): visualization for MS-based proteomics.
- [AlphaQuant](https://github.com/MannLabs/alphaquant): quantification for MS-based proteomics.
------------------------------------------------------------------------
## Citations
Wen-Feng Zeng, Xie-Xuan Zhou, Sander Willems, Constantin Ammar, Maria Wahle, Isabell Bludau, Eugenia Voytik, Maximillian T. Strauss & Matthias Mann. AlphaPeptDeep: a modular deep learning framework to predict peptide properties for proteomics. Nat Commun 13, 7238 (2022). https://doi.org/10.1038/s41467-022-34904-3
------------------------------------------------------------------------
## License
AlphaBase was developed by the [Mann Labs at the Max Planck Institute of Biochemistry](https://www.biochem.mpg.de/mann) and the [University of Copenhagen](https://www.cpr.ku.dk/research/proteomics/mann/) and is
freely available with an [Apache License](LICENSE.txt). External Python
packages (available in the [requirements](requirements) folder) have
their own licenses, which can be consulted on their respective websites.
------------------------------------------------------------------------
## Installation
AlphaBase can be installed and used on all major operating systems
(Windows, macOS and Linux). There are two different types of
installation possible:
- [**Pip installer:**](#pip) Choose this installation if you want to use
AlphaBase as a Python package in an existing Python 3.8 environment
(e.g. a Jupyter notebook).
- [**Developer installer:**](#developer) Choose this installation if you
are familiar with [conda](https://docs.conda.io/en/latest/) and
Python. This installation allows access to all available features of
AlphaBase and even allows to modify its source code directly.
Generally, the developer version of AlphaBase outperforms the
precompiled versions which makes this the installation of choice for
high-throughput experiments.
### Pip
AlphaBase can be installed in an existing Python 3.8 environment with a
single `bash` command. *This `bash` command can also be run directly
from within a Jupyter notebook by prepending it with a `!`*:
``` bash
pip install alphabase
```
Installing AlphaBase like this avoids conflicts when integrating it in
other tools, as this does not enforce strict versioning of dependancies.
However, if new versions of dependancies are released, they are not
guaranteed to be fully compatible with AlphaBase. While this should only
occur in rare cases where dependencies are not backwards compatible, you
can always force AlphaBase to use dependancy versions which are known to
be compatible with:
``` bash
pip install "alphabase[stable]"
```
NOTE: You might need to run `pip install -U pip` before installing
AlphaBase like this. Also note the double quotes `"`.
For those who are really adventurous, it is also possible to directly
install any branch (e.g. `@development`) with any extras
(e.g. `#egg=alphabase[stable,development-stable]`) from GitHub with e.g.
``` bash
pip install "git+https://github.com/MannLabs/alphabase.git@development#egg=alphabase[stable,development-stable]"
```
### Developer
AlphaBase can also be installed in editable (i.e. developer) mode with a
few `bash` commands. This allows to fully customize the software and
even modify the source code to your specific needs. When an editable
Python package is installed, its source code is stored in a transparent
location of your choice. While optional, it is advised to first (create
and) navigate to e.g. a general software folder:
``` bash
mkdir ~/folder/where/to/install/software
cd ~/folder/where/to/install/software
```
***The following commands assume you do not perform any additional `cd`
commands anymore***.
Next, download the AlphaBase repository from GitHub either directly or
with a `git` command. This creates a new AlphaBase subfolder in your
current directory.
``` bash
git clone https://github.com/MannLabs/alphabase.git
```
For any Python package, it is highly recommended to use a separate
[conda virtual environment](https://docs.conda.io/en/latest/), as
otherwise *dependancy conflicts can occur with already existing
packages*.
``` bash
conda create --name alphabase python=3.9 -y
conda activate alphabase
```
Finally, AlphaBase and all its [dependancies](requirements) need to be
installed. To take advantage of all features and allow development (with
the `-e` flag), this is best done by also installing the [development
dependencies](requirements/requirements_development.txt) instead of only
the [core dependencies](requirements/requirements.txt):
``` bash
pip install -e "./alphabase[development]"
```
By default this installs loose dependancies (no explicit versioning),
although it is also possible to use stable dependencies
(e.g. `pip install -e "./alphabase[stable,development-stable]"`).
***By using the editable flag `-e`, all modifications to the [AlphaBase
source code folder](alphabase) are directly reflected when running
AlphaBase. Note that the AlphaBase folder cannot be moved and/or renamed
if an editable version is installed. In case of confusion, you can
always retrieve the location of any Python module with e.g. the command
`import module` followed by `module.__file__`.***
------------------------------------------------------------------------
## Usage
TODO
------------------------------------------------------------------------
## Troubleshooting
In case of issues, check out the following:
- [Issues](https://github.com/MannLabs/alphabase/issues): Try a few
different search terms to find out if a similar problem has been
encountered before
- [Discussions](https://github.com/MannLabs/alphabase/discussions):
Check if your problem or feature requests has been discussed before.
------------------------------------------------------------------------
## How to contribute
If you like this software, you can give us a
[star](https://github.com/MannLabs/alphabase/stargazers) to boost our
visibility! All direct contributions are also welcome. Feel free to post
a new [issue](https://github.com/MannLabs/alphabase/issues) or clone the
repository and create a [pull
request](https://github.com/MannLabs/alphabase/pulls) with a new branch.
For an even more interactive participation, check out the
[discussions](https://github.com/MannLabs/alphabase/discussions) and the
[the Contributors License Agreement](misc/CLA.md).
### Notes for developers
#### Tagging of changes
In order to have release notes automatically generated, changes need to be tagged with labels.
The following labels are used (should be safe-explanatory):
`breaking-change`, `bug`, `enhancement`.
#### Release a new version
This package uses a shared release process defined in the
[alphashared](https://github.com/MannLabs/alphashared) repository. Please see the instructions
[there](https://github.com/MannLabs/alphashared/blob/reusable-release-workflow/.github/workflows/README.md#release-a-new-version).
#### pre-commit hooks
It is highly recommended to use the provided pre-commit hooks, as the CI pipeline enforces all checks therein to
pass in order to merge a branch.
The hooks need to be installed once by
```bash
pre-commit install
```
You can run the checks yourself using:
```bash
pre-commit run --all-files
```
------------------------------------------------------------------------
## Changelog
See the [HISTORY.md](HISTORY.md) for a full overview of the changes made
in each version.
Raw data
{
"_id": null,
"home_page": "https://github.com/MannLabs/alphabase",
"name": "alphabase",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "bioinformatics, software, AlphaX ecosystem",
"author": "Mann Labs",
"author_email": "jalew188@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a0/bf/4d49d7a624f4791529bab00d604250b020e28810c584de4fb9ae340f9357/alphabase-1.4.2.tar.gz",
"platform": null,
"description": "# AlphaBase\n\n\n\n[](https://alphabase.readthedocs.io/en/latest/?badge=latest)\n[](https://pypi.org/project/alphabase)\n[](https://pypi.org/project/alphabase)\n\n\nAlphaBase provides all basic python functionalities for AlphaPept\necosystem from the [Mann Labs at the Max Planck Institute of\nBiochemistry](https://www.biochem.mpg.de/mann) and the [University of\nCopenhagen](https://www.cpr.ku.dk/research/proteomics/mann/). To enable\nall hyperlinks in this document, please view it at\n[GitHub](https://github.com/MannLabs/alphabase). For documentation,\nplease see [readthedocs](https://alphabase.readthedocs.io/en/latest).\n\n- [**About**](#about)\n- [**License**](#license)\n- [**Installation**](#installation)\n - [**Pip installer**](#pip)\n - [**Developer installer**](#developer)\n- [**Usage**](#usage)\n- [**Troubleshooting**](#troubleshooting)\n- [**Citations**](#citations)\n- [**How to contribute**](#how-to-contribute)\n- [**Changelog**](#changelog)\n\n------------------------------------------------------------------------\n\n## About\n\nThe infrastructure package of AlphaX ecosystem for MS proteomics. It was first published with AlphaPeptDeep, see [Citations](#citations).\n\n### Packages built upon AlphaBase\n\n- [AlphaPeptDeep](https://github.com/MannLabs/alphapeptdeep): deep learning framework for proteomics.\n- [AlphaRaw](https://github.com/MannLabs/alpharaw): raw data reader for different vendors.\n- [AlphaDIA](https://github.com/MannLabs/alphadia): DIA search engine.\n- [PeptDeep-HLA](https://github.com/MannLabs/peptdeep-hla): personalized HLA-binding peptide prediction.\n- [AlphaViz](https://github.com/MannLabs/alphaviz): visualization for MS-based proteomics.\n- [AlphaQuant](https://github.com/MannLabs/alphaquant): quantification for MS-based proteomics.\n\n------------------------------------------------------------------------\n\n## Citations\n\nWen-Feng Zeng, Xie-Xuan Zhou, Sander Willems, Constantin Ammar, Maria Wahle, Isabell Bludau, Eugenia Voytik, Maximillian T. Strauss & Matthias Mann. AlphaPeptDeep: a modular deep learning framework to predict peptide properties for proteomics. Nat Commun 13, 7238 (2022). https://doi.org/10.1038/s41467-022-34904-3\n\n------------------------------------------------------------------------\n\n## License\n\nAlphaBase was developed by the [Mann Labs at the Max Planck Institute of Biochemistry](https://www.biochem.mpg.de/mann) and the [University of Copenhagen](https://www.cpr.ku.dk/research/proteomics/mann/) and is\nfreely available with an [Apache License](LICENSE.txt). External Python\npackages (available in the [requirements](requirements) folder) have\ntheir own licenses, which can be consulted on their respective websites.\n\n------------------------------------------------------------------------\n\n## Installation\n\nAlphaBase can be installed and used on all major operating systems\n(Windows, macOS and Linux). There are two different types of\ninstallation possible:\n\n- [**Pip installer:**](#pip) Choose this installation if you want to use\n AlphaBase as a Python package in an existing Python 3.8 environment\n (e.g.\u00a0a Jupyter notebook).\n- [**Developer installer:**](#developer) Choose this installation if you\n are familiar with [conda](https://docs.conda.io/en/latest/) and\n Python. This installation allows access to all available features of\n AlphaBase and even allows to modify its source code directly.\n Generally, the developer version of AlphaBase outperforms the\n precompiled versions which makes this the installation of choice for\n high-throughput experiments.\n\n### Pip\n\nAlphaBase can be installed in an existing Python 3.8 environment with a\nsingle `bash` command. *This `bash` command can also be run directly\nfrom within a Jupyter notebook by prepending it with a `!`*:\n\n``` bash\npip install alphabase\n```\n\nInstalling AlphaBase like this avoids conflicts when integrating it in\nother tools, as this does not enforce strict versioning of dependancies.\nHowever, if new versions of dependancies are released, they are not\nguaranteed to be fully compatible with AlphaBase. While this should only\noccur in rare cases where dependencies are not backwards compatible, you\ncan always force AlphaBase to use dependancy versions which are known to\nbe compatible with:\n\n``` bash\npip install \"alphabase[stable]\"\n```\n\nNOTE: You might need to run `pip install -U pip` before installing\nAlphaBase like this. Also note the double quotes `\"`.\n\nFor those who are really adventurous, it is also possible to directly\ninstall any branch (e.g.\u00a0`@development`) with any extras\n(e.g.\u00a0`#egg=alphabase[stable,development-stable]`) from GitHub with e.g.\n\n``` bash\npip install \"git+https://github.com/MannLabs/alphabase.git@development#egg=alphabase[stable,development-stable]\"\n```\n\n### Developer\n\nAlphaBase can also be installed in editable (i.e.\u00a0developer) mode with a\nfew `bash` commands. This allows to fully customize the software and\neven modify the source code to your specific needs. When an editable\nPython package is installed, its source code is stored in a transparent\nlocation of your choice. While optional, it is advised to first (create\nand) navigate to e.g.\u00a0a general software folder:\n\n``` bash\nmkdir ~/folder/where/to/install/software\ncd ~/folder/where/to/install/software\n```\n\n***The following commands assume you do not perform any additional `cd`\ncommands anymore***.\n\nNext, download the AlphaBase repository from GitHub either directly or\nwith a `git` command. This creates a new AlphaBase subfolder in your\ncurrent directory.\n\n``` bash\ngit clone https://github.com/MannLabs/alphabase.git\n```\n\nFor any Python package, it is highly recommended to use a separate\n[conda virtual environment](https://docs.conda.io/en/latest/), as\notherwise *dependancy conflicts can occur with already existing\npackages*.\n\n``` bash\nconda create --name alphabase python=3.9 -y\nconda activate alphabase\n```\n\nFinally, AlphaBase and all its [dependancies](requirements) need to be\ninstalled. To take advantage of all features and allow development (with\nthe `-e` flag), this is best done by also installing the [development\ndependencies](requirements/requirements_development.txt) instead of only\nthe [core dependencies](requirements/requirements.txt):\n\n``` bash\npip install -e \"./alphabase[development]\"\n```\n\nBy default this installs loose dependancies (no explicit versioning),\nalthough it is also possible to use stable dependencies\n(e.g.\u00a0`pip install -e \"./alphabase[stable,development-stable]\"`).\n\n***By using the editable flag `-e`, all modifications to the [AlphaBase\nsource code folder](alphabase) are directly reflected when running\nAlphaBase. Note that the AlphaBase folder cannot be moved and/or renamed\nif an editable version is installed. In case of confusion, you can\nalways retrieve the location of any Python module with e.g.\u00a0the command\n`import module` followed by `module.__file__`.***\n\n------------------------------------------------------------------------\n\n## Usage\n\nTODO\n\n------------------------------------------------------------------------\n\n## Troubleshooting\n\nIn case of issues, check out the following:\n\n- [Issues](https://github.com/MannLabs/alphabase/issues): Try a few\n different search terms to find out if a similar problem has been\n encountered before\n- [Discussions](https://github.com/MannLabs/alphabase/discussions):\n Check if your problem or feature requests has been discussed before.\n\n------------------------------------------------------------------------\n\n## How to contribute\n\nIf you like this software, you can give us a\n[star](https://github.com/MannLabs/alphabase/stargazers) to boost our\nvisibility! All direct contributions are also welcome. Feel free to post\na new [issue](https://github.com/MannLabs/alphabase/issues) or clone the\nrepository and create a [pull\nrequest](https://github.com/MannLabs/alphabase/pulls) with a new branch.\nFor an even more interactive participation, check out the\n[discussions](https://github.com/MannLabs/alphabase/discussions) and the\n[the Contributors License Agreement](misc/CLA.md).\n\n### Notes for developers\n\n#### Tagging of changes\nIn order to have release notes automatically generated, changes need to be tagged with labels.\nThe following labels are used (should be safe-explanatory):\n`breaking-change`, `bug`, `enhancement`.\n\n#### Release a new version\nThis package uses a shared release process defined in the\n[alphashared](https://github.com/MannLabs/alphashared) repository. Please see the instructions\n[there](https://github.com/MannLabs/alphashared/blob/reusable-release-workflow/.github/workflows/README.md#release-a-new-version).\n\n#### pre-commit hooks\nIt is highly recommended to use the provided pre-commit hooks, as the CI pipeline enforces all checks therein to\npass in order to merge a branch.\n\nThe hooks need to be installed once by\n```bash\npre-commit install\n```\nYou can run the checks yourself using:\n```bash\npre-commit run --all-files\n```\n\n------------------------------------------------------------------------\n\n## Changelog\n\nSee the [HISTORY.md](HISTORY.md) for a full overview of the changes made\nin each version.\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "An infrastructure Python package of the AlphaX ecosystem",
"version": "1.4.2",
"project_urls": {
"Docs": "https://alphabase.readthedocs.io/en/latest/",
"GitHub": "https://github.com/MannLabs/alphabase",
"Homepage": "https://github.com/MannLabs/alphabase",
"Mann Labs at CPR": "https://www.cpr.ku.dk/research/proteomics/mann/",
"Mann Labs at MPIB": "https://www.biochem.mpg.de/mann",
"PyPi": "https://pypi.org/project/alphabase/"
},
"split_keywords": [
"bioinformatics",
" software",
" alphax ecosystem"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33ce5bdbb1427adaf4b2a9ac15666aaf13b3045099394167be5ca32edae533e5",
"md5": "1edc0dd413aa94abeface09e63b0e124",
"sha256": "168da9fcb2f33f6344d082717a3d85d5937ea210545312e9acb6b68a26584d87"
},
"downloads": -1,
"filename": "alphabase-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1edc0dd413aa94abeface09e63b0e124",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 257357,
"upload_time": "2024-11-19T09:19:59",
"upload_time_iso_8601": "2024-11-19T09:19:59.484377Z",
"url": "https://files.pythonhosted.org/packages/33/ce/5bdbb1427adaf4b2a9ac15666aaf13b3045099394167be5ca32edae533e5/alphabase-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0bf4d49d7a624f4791529bab00d604250b020e28810c584de4fb9ae340f9357",
"md5": "afa874c712b4cfad12e871c93ac1530e",
"sha256": "13d50eb2cdf981016852ff9c487b6f0d52647854eda96c5e8e87513f47635e4b"
},
"downloads": -1,
"filename": "alphabase-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "afa874c712b4cfad12e871c93ac1530e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 240161,
"upload_time": "2024-11-19T09:20:01",
"upload_time_iso_8601": "2024-11-19T09:20:01.011227Z",
"url": "https://files.pythonhosted.org/packages/a0/bf/4d49d7a624f4791529bab00d604250b020e28810c584de4fb9ae340f9357/alphabase-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 09:20:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MannLabs",
"github_project": "alphabase",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "alphabase"
}
JSON
