Installation - BlaisProteomics/multiplierz GitHub Wiki

Multiplierz has been packaged to be as easy to install as possible. To ensure that the MS file interface modules work correctly, however, please follow the directions below.

Multiplierz requires 64-bit Python, version 2.7 or later (tested up to 3.7.) You must have installed Python before installing the Multiplierz library. (The mzDesktop standalone environment, however, does not require a Python installation.)

As an alternative to the below, multiplierz can be installed in a Docker image. (Note; as of 12/19, AB SCIEX data format access is not available under Linux.)

Multiplierz can be installed from PyPi through pip:

c:\python27\python.exe -m pip install multiplierz

Alternately, to install from the latest version of this repository, clone this repository to your computer. Navigate to the downloaded Multiplierz directory (which will contain setup.py) and run the command

c:\python27\python.exe setup.py install

This will automatically install multiplierz along with the other Python libraries it requires in order to run.

After installing via either method, check that multiplierz installed successfully by running Python in console mode and executing

import multiplierz

This will also initialize the multiplierz data directory, used to store settings files and persistent data.

Important Note: If you have already installed non-vendor software which uses the AB Sciex Clearcore library or the Agilent MassHunter library, consider uninstalling these modules through the provided uninstall utilities before proceeding. Pre-existing installations may cause the modules required by Multiplierz to not install correctly.

For Thermo .RAW file access, the Microsoft Visual C++ Redistributable package must be installed, which can be obtained free from Microsoft here.

Instrument data file access through mzAPI relies on several pre-compiled link library modules kindly provided by the instrument manufacturers. The modules enabling access to AB Sciex and Agilent data need to be registered with the Windows OS in order to function. For easy installation, the steps of this process have been encapsulated into a Python function included with Multiplierz. Open a command line window and run the command:

 python -m multiplierz.mzAPI.management

(Substituting in the path to your Python executable in place of "python" if necessary.) Multiplierz will display a chart showing the status of each data format interface, and/or prompt for what additional steps are required to activate interfaces that aren't working.

When you first run Multiplierz, it will initialize a settings file that saves default information for searches and other utilities. This file is unique for each user profile on the computer, so that different users on, e.g., a central bioinformatics server can maintain their own settings. The settings file is located at:

C:\Users\<Username>\.multiplierz\settings.txt

Of particular interest are the 'comet directory', 'xtandem directory', and 'mascot server' parameters; these tell mzSearch where to find the respective search engines.