Skip to content

Commit 441480d

Browse files
author
Sarunya Pumma
committed
First commit from Nabeel
0 parents  commit 441480d

File tree

1,241 files changed

+417374
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,241 files changed

+417374
-0
lines changed

README.txt

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
SeqInCloud is a highly scalable parallel implementation of a popular
2+
genetic variant pipeline called genome analysis toolkit (GATK).
3+
SeqInCloud uses the Hadoop MapReduce framework and runs the
4+
workflow in a distributed fashion using multiple compute nodes
5+
provisioned either on-premises or in Microsoft Azure cloud.
6+
7+
SeqInCloud is built on top of GATK version 1.6, which is freely
8+
available under a MIT License via the Broad Institute.
9+
10+
This README contains instructions to build and run SeqInCloud.
11+
12+
Building SeqInCloud
13+
===================
14+
15+
1. Make sure that "java" and "ant" are installed and that the
16+
PATH environment is set correctly.
17+
18+
2. Run "ant" from the directory containing the build.xml file
19+
in order to create the following two jar files in the "binaries"
20+
directory:
21+
22+
a. SeqInCloud.jar, which is the main application jar file
23+
b. SICdeps.jar, which is the dependent jar file
24+
25+
3. To rebuild, you can run "ant clean" followed by "ant"
26+
27+
Running SeqInCloud
28+
==================
29+
30+
1. Conigure a Hadoop cluster
31+
32+
2. Load the dataset and the dependent jar (SICdeps.jar) into HDFS
33+
34+
3. Run SeqInCloud with the command below. This provides a list of
35+
command-line options to use:
36+
37+
# hadoop jar SeqInCloud.jar
38+
39+
NOTE
40+
====
41+
42+
The alignment stage in the pipeline is NOT optimized to use memory efficiently.
43+
The subsequent stages of the pipeline run fine, and hence, it is recommended to
44+
run SeqInCloud on an aligned BAM file.

build.xml

Lines changed: 1285 additions & 0 deletions
Large diffs are not rendered by default.

ivy.xml

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!--
2+
~ Copyright (c) 2012, The Broad Institute
3+
~
4+
~ Permission is hereby granted, free of charge, to any person
5+
~ obtaining a copy of this software and associated documentation
6+
~ files (the "Software"), to deal in the Software without
7+
~ restriction, including without limitation the rights to use,
8+
~ copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
~ copies of the Software, and to permit persons to whom the
10+
~ Software is furnished to do so, subject to the following
11+
~ conditions:
12+
~
13+
~ The above copyright notice and this permission notice shall be
14+
~ included in all copies or substantial portions of the Software.
15+
~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16+
~ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17+
~ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18+
~ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19+
~ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20+
~ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21+
~ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
~ OTHER DEALINGS IN THE SOFTWARE.
23+
-->
24+
25+
<ivy-module version="1.0">
26+
<info organisation="org.broadinstitute" module="Sting"/>
27+
<configurations defaultconfmapping="test->default">
28+
<conf name="default" description="the core dependencies for the GATK"/>
29+
<conf name="test" extends="default" description="external dependencies used for testing and metrics" />
30+
<conf name="scala" extends="default" description="the dependencies for scala"/>
31+
<conf name="queue" extends="scala" description="the dependencies for Queue"/>
32+
</configurations>
33+
<dependencies defaultconf="default">
34+
<dependency org="net.sf" name="sam" rev="latest.integration"/>
35+
<dependency org="net.sf" name="picard" rev="latest.integration"/>
36+
<dependency org="edu.mit.broad" name="picard-private-parts" rev="latest.integration"/>
37+
38+
<!-- Tribble -->
39+
<dependency org="org.broad" name="tribble" rev="latest.integration"/>
40+
41+
<dependency org="log4j" name="log4j" rev="1.2.15"/>
42+
<dependency org="javax.mail" name="mail" rev="1.4.4"/>
43+
<dependency org="colt" name="colt" rev="1.2.0"/>
44+
<!-- <dependency org="jboss" name="javassist" rev="3.7.ga"/> -->
45+
<dependency org="org.simpleframework" name="simple-xml" rev="2.0.4"/>
46+
<dependency org="org.apache.bcel" name="bcel" rev="5.2"/>
47+
48+
<!-- Dependencies for reflections mvn repository -->
49+
<dependency org="org.reflections" name="reflections" rev="0.9.7"/>
50+
51+
<!-- Matrix package from math.nist.gov -->
52+
<dependency org="gov.nist" name="Jama" rev="1.0.2"/>
53+
54+
<!-- Dependencies for the graph aligner -->
55+
<dependency org="org.jgrapht" name="jgrapht-jdk1.5" rev="0.7.3"/>
56+
57+
<!-- Dependencies for the html walker documention -->
58+
<dependency org="org.freemarker" name="freemarker" rev="2.3.18"/>
59+
60+
<!-- Commons Dependencies -->
61+
<dependency org="org.apache.commons" name="commons-email" rev="1.2"/>
62+
<dependency org="org.apache.commons" name="commons-jexl" rev="2.0"/>
63+
<dependency org="commons-lang" name="commons-lang" rev="2.5"/>
64+
<dependency org="commons-logging" name="commons-logging" rev="1.1.1"/>
65+
<dependency org="commons-io" name="commons-io" rev="2.1"/>
66+
<dependency org="commons-cli" name="commons-cli" rev="1.2"/>
67+
<dependency org="org.apache.commons" name="commons-math" rev="2.2" />
68+
<dependency org="com.google.collections" name="google-collections"
69+
rev="1.0"/>
70+
<dependency org="org.apache.hadoop" name="hadoop-core" rev="1.1.0" />
71+
72+
<!-- Lucene core utilities -->
73+
<!-- <dependency org="org.apache.lucene" name="lucene-core" rev="3.0.3"/> -->
74+
75+
<!-- Dependencies for LSF, DRMAA, and other C libraries -->
76+
<dependency org="net.java.dev.jna" name="jna" rev="3.2.7"/>
77+
78+
<!-- Dependencies for amazon.com S3 support -->
79+
<dependency org="net.java.dev.jets3t" name="jets3t" rev="0.8.1"/>
80+
81+
<!-- Dependencies for GridEngine -->
82+
<dependency org="net.sf.gridscheduler" name="drmaa" rev="latest.integration"/>
83+
84+
<!-- Scala dependancies -->
85+
<dependency org="org.scala-lang" name="scala-compiler" rev="2.8.1"/>
86+
<dependency org="org.scala-lang" name="scala-library" rev="2.8.1"/>
87+
88+
<!-- testing and evaluation dependencies -->
89+
<dependency org="org.testng" name="testng" rev="5.14.1" conf="test" />
90+
<dependency org="net.sourceforge.findbugs" name="findbugs" rev="1.3.2" conf="test"/>
91+
<dependency org="net.sourceforge.findbugs" name="findbugs-ant" rev="1.3.2" conf="test"/>
92+
<dependency org="net.sourceforge.findbugs" name="annotations" rev="1.3.2" conf="test"/>
93+
<dependency org="net.sourceforge.findbugs" name="jsr305" rev="1.3.2" conf="test"/>
94+
<dependency org="com.google.code.caliper" name="caliper" rev="1.0-SNAPSHOT" conf="test" />
95+
96+
<!-- Contracts for Java and dependencies -->
97+
<dependency org="com.google.code.cofoja" name="cofoja" rev="1.0-20110609" />
98+
<dependency org="asm" name="asm-all" rev="3.3.1" />
99+
100+
<!-- POI, for reading pipeline files -->
101+
<dependency org="org.apache.poi" name="poi" rev="3.8-beta3" />
102+
<dependency org="org.apache.poi" name="poi-ooxml" rev="3.8-beta3" />
103+
104+
<!-- snpEff annotator for pipelines -->
105+
<dependency org="net.sf.snpeff" name="snpeff" rev="2.0.5" />
106+
107+
<!-- Exclude dependencies on sun libraries where the downloads aren't available but included in the jvm. -->
108+
<exclude org="javax.servlet" />
109+
<exclude org="javax.jms" />
110+
<exclude org="com.sun.*" />
111+
</dependencies>
112+
</ivy-module>

licensing/Apache2.0_License.txt

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

licensing/GATK1_LICENSE.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Copyright (c) 2012 The Broad Institute
2+
3+
Permission is hereby granted, free of charge, to any person
4+
obtaining a copy of this software and associated documentation
5+
files (the "Software"), to deal in the Software without
6+
restriction, including without limitation the rights to use,
7+
copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the
9+
Software is furnished to do so, subject to the following
10+
conditions:
11+
12+
The above copyright notice and this permission notice shall be
13+
included in all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
22+
THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)