Skip to main content

Mass spectrometry query language python implementation

Project description

Mass Spec Query Language

Unit Testing NF Workflow Testing

The Mass Spec Query Language (MassQL) is a domain specific language meant to be a succinct way to express a query in a mass spectrometry centric fashion. It is inspired by SQL, but it attempts to bake in assumptions of mass spectrometry to make querying much more natural for mass spectrometry users. Broadly we attempt to design it according to several principles:

  1. Expressiveness - Capture complex mass spectrometry patterns that the community would like to look for
  2. Precision - Exactly prescribe how to find data without ambiguity
  3. Scalable - Easily facilitating the querying of one spectrum all the way up to entire repositories of data
  4. Relatively Natural - MassQL should be relatively easy to read and write and even use to communicate ideas about mass spectrometry, you know like a language.

Repository Structure

This is the repository to define the language and reference implementation. This contains several parts

  1. Language Grammar
  2. Reference Implementation Python API
  3. Command line Utility to execute
  4. NextFlow Workflow For Large Scale Analysis
  5. ProteoSAFe workflow
  6. Dash interactive exploration


Mingxun Wang is the main creator and developer of MassQL. Contact me for contributing or using it!

Language Specification/Documentation

Checkout specifics for the language, examples, and design patterns at the documentation.

Documentation Link

Python API

To install massql

pip install massql

Here is the most basic operation you can do

from massql import msql_engine

results_df = msql_engine.process_query(input_query, input_filename)

If you want to push in a data frame you already have, you can specify it

from massql import msql_engine
from massql import msql_fileloading

# Loading Data
ms1_df, ms2_df = msql_fileloading.load_data(input_filename)

# Executing Query
results_df = msql_engine.process_query(input_query, input_filename, ms1_df=ms1_df, ms2_df=ms2_df)

Command Line Tool

You can use the command line tool massql to query things or put things into a pipeline.

A few examples of what you can do

massql test.mzML "QUERY scaninfo(MS2DATA)" --output_file results.tsv


API Version


Parsing query into intermediate JSON string

/parse?query=<query string>

Example Link

Visualization of Query

Visualization image of MS1 spectra


Example Link

Visualization image of MS2 spectra



To run tests, you'll need to first fetch some fixtures that are not bundled with the git repo: cd tests && sh ./

You will also want to install the extra requirements for the test suite: pip install -r requirements_test.txt


MIT License

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

massql-0.0.15.tar.gz (33.3 kB view hashes)

Uploaded source

Built Distribution

massql-0.0.15-py3-none-any.whl (36.3 kB view hashes)

Uploaded py3

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