yinyinghao / mzmine3 Goto Github PK

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

Getting started with the Documentation and our YouTube channel

MZmine is a free software; you can redistribute it and/or modify it under the terms of the MIT license.

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

Releases are split into stable releases and the latest development build which reflects the current state of the master branch and is meant for testing purposes. Download options include portable versions and installers for the Window, macOS, and Linux.

Currently, MZmine 3 lacks a signature for macOS. While we are working on this, user can allow MZmine in the macOS Gatekeeper protection by running the following command in the terminal from the folder containing the .app.

sudo xattr -cr MZmine.app

Find a step-by-step guide in the documentations.

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

MZmine development requires Java Development Kit (JDK) version 16 or newer (http://jdk.java.net).

To build the MZmine package from the sources, run the following command:

./gradlew

or

gradlew.bat

The final MZmine distribution will be placed in build/jpackage

If you encounter any problems, please contact the developers: https://github.com/mzmine/mzmine3/issues

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").