MZmine 2 source repository
Clone or download
Latest commit f391cc5 Sep 19, 2018

README.md

About MZmine 2

Build Status

MZmine 2 is an open-source software for mass-spectrometry data processing. The goals of the project is to provide a user-friendly, flexible and easily extendable software with a complete set of modules covering the entire MS data analysis workflow.

More information about the software can be found on the MZmine website.

Java version

MZmine requires Java runtime (JRE) version 1.8 or newer.

License

MZmine 2 is a free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

MZmine 2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Development

Tutorial

Please read our brief tutorial on how to contribute new code to MZmine.

Code style

Since this is a collaborative project, please adhere to the following code formatting conventions:

  • We use the Google Java Style Guide (https://github.com/google/styleguide)
  • Please write JavaDoc comments as full sentences, starting with a capital letter and ending with a period. Brevity is preferred (e.g., "Calculates standard deviation" is preferred over "This method calculates and returns a standard deviation of given set of numbers").