Added README and reorganized directory structure (breaks code)
[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 What it does?
12 =============
13
14   * View, annotate, measure force curves
15   * Worm-like chain and freely-jointed chain fit of force peaks
16   * Automatic convolution-based filtering of empty curves
17   * Automatic fit and measurement of multiple force peaks
18   * Handles force-clamp force experiments (experimental)
19   * It is extensible by users by mean of plugins and drivers
20
21 See the Google Code website for more details
22   http://code.google.com/p/hooke/
23
24 Is this published in some peer-reviewed journal?
25 ================================================
26
27 Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.
28 "Hooke: an open software platform for force spectroscopy."
29 Bioinformatics, 2009 25(11):1428-1430.
30 doi:10.1093/bioinformatics/btp180
31
32 Please cite Hooke if you use it.
33
34 Troubleshooting
35 ===============
36
37 If you have troubles in using it, before throwing it in the trash:
38   1) try look at the TroubleShooting page or in the discussion group
39   2) ask a question in the discussion group!
40 http://groups.google.com/group/hookesoftware
41
42 Disclaimer
43 ==========
44
45 Remember that Hooke is still experimental software! It has been mostly
46 done to fit the needs of its authors, and there is no guarantee it
47 will do what you need. However, you can write us/help us improve it so
48 that it does. We aim to make of Hooke a little, universal tool that
49 can help your research.