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