Magnum Source Code

Download .zip Download .tar.gz View on GitHub

Magnum is provided open source for free. Advanced users may wish to compile the source code for their custom system, or modify it for their own purposes. Below are instructions for installation on a Linux-based system using the command-line. It is assumed that version control software is already installed on the system. Magnum can also be compiled for other operating systems/development environments including, but not limited to, Microsoft Visual Studio for Windows. Specific development environment instructions are outside the scope of this document, as it is assumed users of those environments are already familiar with them.

Building Magnum

Step 1: Check out the Magnum repository

Obtain the source code from any of the three options presented above.

Step 2: Check out the supporting software libraries

  1. MSToolkit - used to support multiple file formats.
  2. Hardklor - used for spectral processing functions.
  3. NeoPepXMLParser - used for exporting pepXML results.

Both of these software tools have their own source repositories, applications, and instructions for use. For compiling Magnum from source, they simply need to be compiled on the system you are using.

Step 3: Build support software

Both MSToolkit and Hardklor come with Makefiles. Compile MSToolkit first. Go into the MSToolkit directory and execute the Makefile. For example:

MSToolkit> make

When MSToolkit has finished building, compile Hardklor. To do so, change to the Hardklor directory. Open the Makefile first and set the path to your MSToolkit directory.

LIBPATH = /yourpath/MSToolkit

Save the Makefile. Then make Hardklor by typing ‘make’ on the command line.

Hardklor> make

Last, compile your NeoPepXMLParser library. Go into the NeoPepXMLParser directory and execute the Makefile:

NeoPepXMLParser> make

Step 4: Update paths in the Magnum Makefile

Navigate to your Magnum directory. Open Makefile with any text editor. Edit ‘MSTOOLKITPATH’ and ‘HARDKLORPATH’ and ‘PEPXMLPATH’ to the location of your MSToolkit and Hardklor and NeoPepXMLParser directories:

MSTOOLKITPATH = /yourpath/MSToolkit
HARDKLORPATH = /yourpath/Hardklor
PEPXMLPATH = /yourpath/NeoPepXMLParser

Save the changes in the Makefile.

Step 5: Make Magnum

Type ‘make’ from the command line.

Magnum> make