Merged my unitary FFT wrappers (FFT_tools) as hooke.util.fft.
[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/USAGE file distributed with hooke.
30
31
32 Is this published in some peer-reviewed journal?
33 ================================================
34
35 Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.
36 "Hooke: an open software platform for force spectroscopy."
37 Bioinformatics, 2009 25(11):1428-1430.
38 doi:10.1093/bioinformatics/btp180
39
40 Please cite Hooke if you use it.
41
42
43 Troubleshooting
44 ===============
45
46 If you have troubles in using it, before throwing it in the trash:
47   1) try look at the TroubleShooting page or in the discussion group
48   2) ask a question in the discussion group!
49 http://groups.google.com/group/hookesoftware
50
51
52 Disclaimer
53 ==========
54
55 Remember that Hooke is still experimental software! It has been mostly
56 done to fit the needs of its authors, and there is no guarantee it
57 will do what you need. However, you can write us/help us improve it so
58 that it does. We aim to make of Hooke a little, universal tool that
59 can help your research.