Skip to content

MSDK source code repository (OSGi / Eclipse RCP ready)

License

Notifications You must be signed in to change notification settings

SilicoSciences/io.github.msdk

 
 

Repository files navigation

About this Fork

This fork enables Eclipse RCP features for the MSDK project. Project's pom.xml files have been replaced by a pom.xml that supports building Eclipse RCP Plug-ins with Tycho. Furthermore, required aditional files, such as META-INF/MANIFEST.MF have been created.

See BUILD.md for more info.

Dependencies

  1. FindBugs provides an Eclipse update site: http://findbugs.cs.umd.edu/eclipse.

  2. Google's Guava is contained in the Eclipse Orbit p2 repository.

About MSDK

Mass Spectrometry Development Kit (MSDK) is a Java library of algorithms for processing mass spectrometry data. The goals of the library are to provide a flexible data model with Java interfaces for mass-spectrometry related objects (including raw spectra, processed data sets, identification results etc.) and to integrate the existing algorithms that are currently scattered around various Java-based graphical tools.

Java version

MSDK requires Java runtime (JRE) version 1.7 or newer.

Usage

API

Please see the complete MSDK API.

Maven artifacts

This Fork does not support build using vanilla Maven.

Development

Tutorial

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

Code style

Since this is a collaborative project, please adhere to the following code formatting conventions:

  • All Java sources should be formatted according to the official Java Code Conventions with only one adjustment: use spaces for indentation instead of tabs
  • You can use the msdk-eclipse-code-formater.xml file to automatically format your code in the Eclipse IDE
  • 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").

Logging

MSDK uses the SLF4J library for logging. This library can forward all logging calls to your favorite logging framework (java.util.logging, Apache log4j, or others). Please see SLF4J documentation for details.

Building

See the BUILD.md file.

About

MSDK source code repository (OSGi / Eclipse RCP ready)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%