-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.html
129 lines (91 loc) · 7.19 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="MSDK : Mass Spectrometry Development Kit">
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>MSDK</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/msdk">View on GitHub</a>
<img src="images/msdk_logo.png" width="90" height="90" align="left" style="background: white; margin-right: 25px;">
<h1 id="project_title">MSDK</h1>
<h2 id="project_tagline">Mass Spectrometry Development Kit</h2>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h3>
<a id="what-is-msdk" class="anchor" href="#what-is-msdk" aria-hidden="true"><span class="octicon octicon-link"></span></a>What is MSDK?</h3>
<p>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, such as (in alphabetical order):</p>
<ul>
<li><a href="https://code.google.com/p/guineu/">Guineu</a></li>
<li><a href="http://software.iab.keio.ac.jp/jdamp/">JDAMP</a></li>
<li><a href="https://github.com/nilshoffmann/maltcms">Maltcms</a></li>
<li><a href="https://bitbucket.org/sbeisken/masscascade/">MassCascade</a></li>
<li><a href="http://sing.ei.uvigo.es/mass-up/">Mass-Up</a></li>
<li><a href="https://github.com/nilshoffmann/maui">Maui</a>, <a href="http://bimsbstatic.mdc-berlin.de/kempa/software/kempaSoftware.html">Maui-VIA</a></li>
<li><a href="http://proteomics.fhcrc.org/CPL/msinspect/index.html">msInspect</a></li>
<li><a href="http://mzmatch.sourceforge.net">mzMatch</a></li>
<li><a href="http://mzmine.github.io">MZmine</a></li>
<li><a href="https://www.openchrom.net">OpenChrom</a></li>
<li><a href="https://code.google.com/p/proteo-suite/">ProteoSuite</a></li>
<li><a href="http://bio.informatik.uni-jena.de/sirius2/">SIRIUS</a></li>
</ul>
<h3>
<a id="why-do-we-need-msdk" class="anchor" href="#why-do-we-need-msdk" aria-hidden="true"><span class="octicon octicon-link"></span></a>Why do we need MSDK?</h3>
<p>While competition among various algorithms is beneficial for the progress of research, the absence of a common data model and development platform makes it difficult and laborious to evaluate the results and performance of different algorithms. MSDK addresses this issue for the Java platform, while other projects such as <a href="http://open-ms.sourceforge.net">OpenMS</a> or <a href="http://proteowizard.sourceforge.net">ProteoWizard</a> address this issue in C/C++. The advantages of Java are its multi-platform nature and easy, rapid development in a higher-level language compared to C/C++.</p>
<h3>
<a id="usage" class="anchor" href="#usage" aria-hidden="true"><span class="octicon octicon-link"></span></a>Usage</h3>
<h4>
<a id="api" class="anchor" href="#api" aria-hidden="true"><span class="octicon octicon-link"></span></a>API</h4>
<p>Please see the complete <a href="http://msdk.github.io/api/">MSDK API</a>.</p>
<h4>
<a id="maven-artifacts" class="anchor" href="#maven-artifacts" aria-hidden="true"><span class="octicon octicon-link"></span></a>Maven artifacts</h4>
<p>MSDK jars are automatically deployed to Maven Central. In order to use MSDK, simply add the following dependency to your pom.xml:</p>
<pre><code> <dependency>
<groupId>io.github.msdk</groupId>
<artifactId>msdk-all</artifactId>
<version>0.0.3</version>
</dependency>
</code></pre>
<h3>
<a id="java-version" class="anchor" href="#java-version" aria-hidden="true"><span class="octicon octicon-link"></span></a>Java version</h3>
<p>MSDK requires Java runtime (JRE) version 1.8 or newer.</p>
<h3>
<a id="license" class="anchor" href="#license" aria-hidden="true"><span class="octicon octicon-link"></span></a>License</h3>
<p>MSDK binaries and source codes are dual-licensed under either the terms of the <a href="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License v1.0</a> as published by the Eclipse Foundation</p>
<p>or (per the licensee's choosing)</p>
<p>under the terms of the GNU <a href="http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html">Lesser General Public License version 2.1</a> as published by the Free Software Foundation.</p>
<h3>
<a id="contributors" class="anchor" href="#contributors" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contributors</h3>
<p>Please use GitHub's <a href="https://github.com/msdk/msdk/graphs/contributors">statistics</a> to see who has contributed to this project so far. The <a href="https://help.github.com/articles/using-git-blame-to-trace-changes-in-a-file">Git Blame</a> feature can be used to track the authorship of each individual line in the source codes.</p>
<h3>
<a id="how-to-join-this-project" class="anchor" href="#how-to-join-this-project" aria-hidden="true"><span class="octicon octicon-link"></span></a>How to join this project</h3>
<p>Please join our <a href="https://groups.google.com/forum/#!forum/msdk-devel">Google Group</a> and tell us about your ideas. Contributions to MSDK can be made through GitHub's standard <a href="https://help.github.com/articles/using-pull-requests/">Pull Request</a> mechanism. If you are not familiar with this mechanism, please read our brief <a href="pull-request-tutorial.html">tutorial</a>. Before creating a Pull Request, please make sure that you agree with your code being distributed as part of MSDK under the above-mentioned license.</p>
<h3>
<a id="how-to-report-problems" class="anchor" href="#how-to-report-problems" aria-hidden="true"><span class="octicon octicon-link"></span></a>How to report problems</h3>
<p>You can report problems and bugs through the GitHub's <a href="https://github.com/msdk/msdk/issues">Issues tracker</a> or through our <a href="https://groups.google.com/forum/#!forum/msdk-devel">Google Group</a>. Please do so <a href="http://www.chiark.greenend.org.uk/%7Esgtatham/bugs.html">constructively</a>.</p>
<h3>
<a id="source-codes" class="anchor" href="#source-codes" aria-hidden="true"><span class="octicon octicon-link"></span></a>Source codes</h3>
<p>MSDK source codes are available from our <a href="https://github.com/msdk/msdk">GitHub repository</a>. To clone the source code tree, you can use this command:</p>
<pre><code>$ git clone https://github.com/msdk/msdk.git
</code></pre>
<p><a href="http://maven.apache.org">Apache Maven</a> is required to build MSDK. To compile the source codes, run the following command in the source code directory:</p>
<pre><code>$ mvn package
</code></pre>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>