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
|
..
This file is part of khmer, https://github.com/dib-lab/khmer/, and is
Copyright (C) 2014-2015 Michigan State University
It is licensed under the three-clause BSD license; see LICENSE.
Contact: khmer-project@idyll.org
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of the Michigan State University nor the names
of its contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Contact: khmer-project@idyll.org
Hackathon information (July 2014)
=================================
This document is for contributors to the July 2014 Hackathon (see `the
blog post <http://ivory.idyll.org/blog/2014-khmer-hackathon.html>`__).
----
Please track `khmer issue #446
<https://github.com/dib-lab/khmer/issues/446>`__ for up-to-the-minute
information. You can subscribe to this issue (lower right on issue page)
to get automatic e-mail updates.
**Start here!** :doc:`getting-started`
Introducing...
--------------
khmer is a piece of scientific software that does cool stuff in biology.
(That's really all you need to know for the Hackathon, honestly; but you
can read more about khmer `here <http://figshare.com/articles/The_khmer_software_package_enabling_efficient_sequence_analysis/979190>`__ if you like.)
The important bit about khmer is that we develop it openly,
at https://github.com/dib-lab/khmer; we use reasonably OK software development
practices; and we're interested in spreading the gospel, so to speak.
So! For this Hackathon, we're providing a "mentored software
development experience". We'll walk you through the "GitHub Flow"
process `(link)
<http://scottchacon.com/2011/08/31/github-flow.html>`__, which will
involve making your own copy of khmer, getting it compiled and running
the tests, claiming an issue, requesting a merge, watching our
continuous integration engine run your changes, and going through code
review. What fun!
To get started, go to :doc:`getting-started`!
You can contact us directly at khmer-project@idyll.org, but if you're
experience trouble of any kind, please feel to `create an issue
<https://github.com/dib-lab/khmer/issues?direction=desc&sort=created&state=open>`__
where we can help you out. Also keep an eye on `issue #446
<https://github.com/dib-lab/khmer/issues/446>`__ where we're updating
Hackathon information more generally.
Problems, questions, and solutions
----------------------------------
#. I don't have access to a UNIX machine that can compile khmer. What can
I do?
Contact us at khmer-project@idyll.org and we'll give you an account
for the duration. You'll need to have an SSH client, note.
#. There's a bug in this documentation! But I can fix it...
Oh noes! Fixes are welcome -- these docs are in branch
'docs/hackathon' on https://github.com/dib-lab/khmer/, so please
send PRs there. Or if you haven't worked through the process yet,
please `add an issue
<https://github.com/dib-lab/khmer/issues?direction=desc&sort=created&state=open>`__ and we'll be on it.
|
