Cleanup reStructuredText in the README.
[hooke.git] / README
1 .. -*- coding: utf-8 -*-
2
3 What it is
4 ==========
5
6 It is a software for the (semiautomatic) analysis and filtering of
7 force curves. Force curves are the output of an analytical technique
8 called force spectroscopy. A force spectroscopy experiment usually
9 requires the analysis of thousands of force curves at a time. As of
10 today, there is no standard, free software for the analysis of force
11 curves. Hooke aims to solve that.
12
13
14 What it does
15 ============
16
17 * View, annotate, measure force curves
18 * Worm-like chain and freely-jointed chain fit of force peaks
19 * Automatic convolution-based filtering of empty curves
20 * Automatic fit and measurement of multiple force peaks
21 * Handles force-clamp force experiments (experimental)
22 * It is extensible by users by mean of plugins and drivers
23
24 See `Hooke's Google Code homepage`_ for more details.
25
26
27 How it works
28 ============
29
30 See the doc/tutorial.txt file distributed with Hooke, or the `online
31 docs`_.
32
33 .. _online docs: http://www.physics.drexel.edu/~wking/rsrch/hooke/
34
35
36 Where it's published
37 ====================
38
39 Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.
40 "Hooke: an open software platform for force spectroscopy."
41 Bioinformatics, 2009 25(11):1428-1430.
42 doi:10.1093/bioinformatics/btp180
43
44 Please cite Hooke if you use it.
45
46
47 Troubleshooting
48 ===============
49
50 If you have troubles in using it, before throwing it in the trash:
51
52 1. Search the `issue tracker`_.
53 2. Look at the `troubleshooting wiki page`_.
54 3. Search the `discussion group`_.
55 4. Ask a question in the discussion group.
56 5. File a bug on the issue tracker.
57
58
59 Disclaimer
60 ==========
61
62 Remember that Hooke is still experimental software! It has been mostly
63 done to fit the needs of its authors, and there is no guarantee it
64 will do what you need. However, you can write us/help us improve it so
65 that it does. We aim to make of Hooke a robust tool that can help your
66 research.
67
68
69 Source
70 ======
71
72 Hooke is available as a Git_ repository::
73
74     $ git clone git://tremily.us/hooke.git
75
76 See the docs_ for installation details.
77
78
79 Licensing
80 =========
81
82 Hooke is released under the GNU Lesser General Public License, either
83 version 3 of the License (COPYING and COPYING.LESSER), or (at your
84 option) any later version.
85
86 .. _Hooke's Google Code homepage: http://code.google.com/p/hooke/
87 .. _docs: http://hooke.tremily.us/
88 .. _issue tracker: http://code.google.com/p/hooke/issues/list
89 .. _troubleshooting wiki page:
90   http://code.google.com/p/hooke/wiki/TroubleShooting
91 .. _discussion group: http://groups.google.com/group/hookesoftware
92 .. _Git: http://git-scm.com/