Skip to content

Getting Started

Download

Download mzmine portable versions or installers from GitHub:

https://github.com/mzmine/mzmine/releases/latest

Install

mzmine should work on Windows, macOS, and Linux using either the installers or the portable versions. There are NO further requirements as mzmine packages a specific Java Virtual Machine. This means the local Java installation has no impact on mzmine. Windows and macOS users might be warned that mzmine is not signed or from a trusted source and have to click run anyway.

Before creating your first project, we recommend to set the preferences.

Installation on macOS

Download the latest version of the mzmine_macOS_installer_academia.dmg. Double click to start installation and drag and drop mzmine.app into the Applications folder.

macOS_installer

Select "replace" to override older versions. First time starting mzmine may trigger a warning "mzmine.app" Not Opened on macOS 15 or later.

macOS_mzmine_not_opened

To open mzmine, go to System Settings, scroll down to Privacy & Security, and click on "Open Anyway" next to the message "mzmine.app" was blocked to protect your Mac.

macOS_mzmine_not_opened

A new message pops up. Click again on "Open Anyway" and enter your macOS password.

macOS_mzmine_not_opened

This procedure only has to be done once. Now, mzmine can be started like other applications.

Installation on Linux

Download the latest version, install mzmine, login, and run mzmine. See mzmine command-line interface as a reference.

# with gh (github) installed, download of latest .deb installer is quite easy
# gh auth login
# sudo apt install gh
# gh release download --repo mzmine/mzmine --pattern "mzmine*.deb"

# or find installer at https://github.com/mzmine/mzmine/releases/latest 
wget https://github.com/mzmine/mzmine/releases/download/text-action-release/mzmine_4.3.1_amd64.deb

# create required dir and install mzmine
sudo mkdir -p /usr/share/desktop-directories/
sudo apt install mzmine*.deb

# potential dependencies that may be required 
# sudo apt-get install xdg-utils
# sudo apt-get install libgl1
# sudo apt-get install libgtk-3-0
# sudo apt-get install libxtst6

# run mzmine and print help. also check -login-console -batch
/opt/mzmine/bin/mzmine -help

Sign in / Sign up

Open the Users/User management to sign in to an existing user or sign up for a free user account (more details). Sign-in

Set User Preferences

Before creating your first project, we recommend setting up some things.

  1. Set a temporary file directory. Go to ProjectSet preferencesTemporary file directory. This requires a restart to take effect.

    1. We recommend setting the directory to an SSD with enough space for fast processing and visualizations.
    2. On Windows, old temporary files are deleted when a new session is started. settings
  2. mzmine 2 and mzmine 3 projects cannot be imported due to changes in the data structure.

  3. mzmine 2 and mzmine 3 batch files cannot be imported due to parameter optimizations.

You can get familiar with the new GUI here: Main window overview

Start processing

As a quick start you can use the mzwizard in the main menu or directly on the landing page.

A good starting point is watching this mzmine video tutorial on YouTube. YouTube tutorial

A quick insight to data processing workflows can be found here: - LC-MS workflow - LC-IMS-IMS workflow - Imaging workflows

Running mzmine

mzmine provides a user-friendly graphical user interface (GUI) that facilitates data exploration, batch optimization, and results validation. If the batch processing is optimized and the goal is to solely produce the output files without the need for a GUI, we recommend running mzmine as a command-line tool.

Ansgar Korf, Robin Schmid, Steffen Heuckeroth, amcaraballor, omokshyna


Last update: November 11, 2024 09:55:33