Skip to content

mzmine/mzmine

Repository files navigation

logo300_mzmine.png

GitHub all releases GitHub all releases GitHub contributors Development Build Release Static Badge Static Badge

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

License

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

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.

Development

Tutorial

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

Java version

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

Moving old codebase to new modular build system

If there are still changes pending apply those moves first and then create a PR. Create a backup branch.

git mv -k -v ./src ./mzmine-community/
git mv -v ./log ./mzmine-community/    
git mv -v ./logo ./mzmine-community/    
git mv -v ./Ontologies ./mzmine-community/    

Building

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 by posting an issue: https://github.com/mzmine/mzmine3/issues

Contribute code (or documentation)

Guides and more information is in the mzmine documentation: https://mzmine.github.io/mzmine_documentation/contribute_intellij.html