# Rapid QC-MS
**Rapid QC-MS** is an all-in-one solution for automated quality control of liquid chromatography-mass spectrometry (LC-MS) instrument runs, both during and after data acquisition.
It offers a fast, straightforward approach to ensure collection of high-quality data, allowing for less time investigating raw data and more time conducting experiments.
Developed at the [Mass Spectrometry Platform of CZ Biohub San Francisco](https://www.czbiohub.org/mass-spec/), Rapid QC-MS provides a host of key features to streamline untargeted metabolomics research, such as:
- **Automated and user-defined quality control checks** during instrument runs
- **Realtime updates on QC fails** in the form of Slack or email notifications
- **Interactive data visualization** of internal standard retention time, _m/z_, and intensity across samples
- **Google Drive cloud sync** and secure, Google-authenticated access to QC results from any device
# Requirements
**Rapid QC-MS was designed to run on Windows platforms** because of its dependency on [MSConvert](https://proteowizard.sourceforge.io/tools/msconvert.html) for vendor format data conversion and [MS-DIAL](http://prime.psc.riken.jp/compms/msdial/main.html) for data processing and identification. However, MacOS users can still use Rapid QC-MS to monitor / view their instrument run data.
In addition, Rapid QC-MS requires Python 3.8 to 3.11 and various Python packages, including:
- Pandas
- SQLAlchemy
- Plotly Dash
- Bootstrap
- Watchdog
- Google API
- Slack API
These are installed automatically during setup.
**Note:** Installation of Python and various Python packages on MS instrument computers comes at no risk. For extra security and peace of mind, you can opt to install Rapid QC-MS in a virtual environment. To learn more, please read the [installation guide](https://czbiohub-sf.github.io/Rapid-QC-MS/installation.html#2-install-ms-autoqc).
# Installation
Installing Rapid QC-MS is easy. Simply open your Terminal or Command Prompt and enter:
```python
py -m pip install rapid-qc-ms
```
If you have multiple versions of python on your system, you can specifiy the version you want to use this way
```py -3.# -m pip install ms-autoqc```
Python dependencies are installed automatically, but dependencies such as MSConvert and MS-DIAL will need to be installed manually.
You can also opt to download and install Rapid QC-MS manually, or in a virtual environment if you prefer. Check out the [installation guide](https://czbiohub-sf.github.io/Rapid-QC-MS/installation.html#2-install-ms-autoqc) for more details.
# Usage
To start Rapid QC-MS, simply enter:
```python
rapidqcms
```
Check out the [quickstart guide](https://czbiohub-sf.github.io/Rapid-QC-MS/quickstart.html) to learn how easy setting up new QC jobs is.
# Supported instrument vendors
Rapid QC-MS was designed to be a universal, open-source solution for data quality control. Because MSConvert converts raw acquired data into open mzML format before routing it to the data processing pipeline, the package will work seamlessly with data of all vendor formats.
**However, Rapid QC-MS has only been tested extensively on Thermo Fisher mass spectrometers, Thermo acquisition sequences, and Thermo RAW files.** As such, it is expected that there may be bugs and issues with processing data of other vendor formats.
If you encounter a bug, please report it by [opening an issue on GitHub](https://github.com/czbiohub-sf/Rapid-QC-MS/issues).
We are open to collaboration! If you would like to help us develop support for Agilent, Bruker, Sciex, or Waters acquisition sequences and data files, please send an email to [brian.defelice@czbiohub.org](mailto:brian.defelice@czbiohub.org).
Raw data
{
"_id": null,
"home_page": "",
"name": "rapid-qc-ms",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": "",
"keywords": "mass-spectrometry,mass-spec,autoqc,mass-spec-quality-control",
"author": "",
"author_email": "Brian DeFelice <brian.defelice@czbiohub.org>",
"download_url": "https://files.pythonhosted.org/packages/45/85/d72c44a821a58926afe811a23a34f1c9b86d9a37509be0a6e59e9a285b3b/rapid-qc-ms-1.0.0.tar.gz",
"platform": null,
"description": "# Rapid QC-MS\r\n**Rapid QC-MS** is an all-in-one solution for automated quality control of liquid chromatography-mass spectrometry (LC-MS) instrument runs, both during and after data acquisition.\r\n\r\n\r\n\r\nIt offers a fast, straightforward approach to ensure collection of high-quality data, allowing for less time investigating raw data and more time conducting experiments.\r\n\r\nDeveloped at the [Mass Spectrometry Platform of CZ Biohub San Francisco](https://www.czbiohub.org/mass-spec/), Rapid QC-MS provides a host of key features to streamline untargeted metabolomics research, such as:\r\n\r\n- **Automated and user-defined quality control checks** during instrument runs\r\n- **Realtime updates on QC fails** in the form of Slack or email notifications\r\n- **Interactive data visualization** of internal standard retention time, _m/z_, and intensity across samples\r\n- **Google Drive cloud sync** and secure, Google-authenticated access to QC results from any device\r\n\r\n\r\n\r\n\r\n\r\n# Requirements\r\n**Rapid QC-MS was designed to run on Windows platforms** because of its dependency on [MSConvert](https://proteowizard.sourceforge.io/tools/msconvert.html) for vendor format data conversion and [MS-DIAL](http://prime.psc.riken.jp/compms/msdial/main.html) for data processing and identification. However, MacOS users can still use Rapid QC-MS to monitor / view their instrument run data.\r\n\r\nIn addition, Rapid QC-MS requires Python 3.8 to 3.11 and various Python packages, including:\r\n\r\n- Pandas\r\n- SQLAlchemy\r\n- Plotly Dash\r\n- Bootstrap\r\n- Watchdog\r\n- Google API\r\n- Slack API\r\n\r\nThese are installed automatically during setup.\r\n\r\n**Note:** Installation of Python and various Python packages on MS instrument computers comes at no risk. For extra security and peace of mind, you can opt to install Rapid QC-MS in a virtual environment. To learn more, please read the [installation guide](https://czbiohub-sf.github.io/Rapid-QC-MS/installation.html#2-install-ms-autoqc).\r\n\r\n# Installation\r\nInstalling Rapid QC-MS is easy. Simply open your Terminal or Command Prompt and enter:\r\n```python\r\npy -m pip install rapid-qc-ms\r\n```\r\n\r\nIf you have multiple versions of python on your system, you can specifiy the version you want to use this way\r\n```py -3.# -m pip install ms-autoqc```\r\n\r\nPython dependencies are installed automatically, but dependencies such as MSConvert and MS-DIAL will need to be installed manually.\r\n\r\nYou can also opt to download and install Rapid QC-MS manually, or in a virtual environment if you prefer. Check out the [installation guide](https://czbiohub-sf.github.io/Rapid-QC-MS/installation.html#2-install-ms-autoqc) for more details.\r\n\r\n# Usage\r\nTo start Rapid QC-MS, simply enter:\r\n```python\r\nrapidqcms\r\n```\r\n\r\nCheck out the [quickstart guide](https://czbiohub-sf.github.io/Rapid-QC-MS/quickstart.html) to learn how easy setting up new QC jobs is.\r\n\r\n\r\n\r\n# Supported instrument vendors\r\nRapid QC-MS was designed to be a universal, open-source solution for data quality control. Because MSConvert converts raw acquired data into open mzML format before routing it to the data processing pipeline, the package will work seamlessly with data of all vendor formats.\r\n\r\n**However, Rapid QC-MS has only been tested extensively on Thermo Fisher mass spectrometers, Thermo acquisition sequences, and Thermo RAW files.** As such, it is expected that there may be bugs and issues with processing data of other vendor formats.\r\n\r\nIf you encounter a bug, please report it by [opening an issue on GitHub](https://github.com/czbiohub-sf/Rapid-QC-MS/issues).\r\n\r\nWe are open to collaboration! If you would like to help us develop support for Agilent, Bruker, Sciex, or Waters acquisition sequences and data files, please send an email to [brian.defelice@czbiohub.org](mailto:brian.defelice@czbiohub.org).\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Realtime quality control for mass spectrometry data acquisition",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://czbiohub-sf.github.io/Rapid-QC-MS"
},
"split_keywords": [
"mass-spectrometry",
"mass-spec",
"autoqc",
"mass-spec-quality-control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3a382f8022c66a7a8555a694875be57b37d8790d39a294d23ed91b384ad2540",
"md5": "4d32774c9591531737153b19ac340d66",
"sha256": "7c339b0b7d9cdb479f2c20861b3cd27e338df6097a6d97cb51b4b842c5f96002"
},
"downloads": -1,
"filename": "rapid_qc_ms-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d32774c9591531737153b19ac340d66",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 144879,
"upload_time": "2024-01-25T00:13:29",
"upload_time_iso_8601": "2024-01-25T00:13:29.769494Z",
"url": "https://files.pythonhosted.org/packages/a3/a3/82f8022c66a7a8555a694875be57b37d8790d39a294d23ed91b384ad2540/rapid_qc_ms-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4585d72c44a821a58926afe811a23a34f1c9b86d9a37509be0a6e59e9a285b3b",
"md5": "32e4625b6d2dab10c0227419cc59dc03",
"sha256": "97da7787d71ee6e5e8428d277c77f90da6a8575ace8dfd2094b774e64d284032"
},
"downloads": -1,
"filename": "rapid-qc-ms-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "32e4625b6d2dab10c0227419cc59dc03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 141021,
"upload_time": "2024-01-25T00:13:31",
"upload_time_iso_8601": "2024-01-25T00:13:31.876613Z",
"url": "https://files.pythonhosted.org/packages/45/85/d72c44a821a58926afe811a23a34f1c9b86d9a37509be0a6e59e9a285b3b/rapid-qc-ms-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 00:13:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rapid-qc-ms"
}
JSON