Split out "Troubleshooting" into doc/bugs.txt.
[hooke.git] / doc / index.txt
1 Welcome
2 =======
3
4 Hooke_ is software for the (semiautomatic) analysis and filtering of
5 force curves.  Force curves are the output of an analytical technique
6 called `force spectroscopy`_.  Force spectroscopy experiments usually
7 require 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 .. _Hooke: http://code.google.com/p/hooke/
12 .. _force spectroscopy: http://en.wikipedia.org/wiki/Force_spectroscopy
13
14 Features:
15
16 * View, annotate, and measure force curves
17 * Worm-like chain and freely-jointed chain fits of force peaks
18 * Automatic convolution-based filtering of empty curves
19 * Automatic fit and measurement of multiple force peaks
20 * Handles force-clamp force experiments (experimental)
21 * Extensible by users by mean of plugins and drivers 
22
23 Contents
24 ========
25
26 .. toctree::
27    :maxdepth: 2
28
29    install
30    tutorial
31    config
32    bugs
33    hacking
34    hooke/hooke
35    doc
36
37 Indices and tables
38 ------------------
39
40 * :ref:`genindex`
41 * :ref:`modindex`
42 * :ref:`search`
43
44 Publications
45 ============
46
47 Hooke has been published [1]. Please cite Hooke if you use it.  Let us
48 know, and we'll link to your paper!
49
50
51 [1] Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.,
52   "Hooke: an open software platform for force spectroscopy."
53   Bioinformatics, 2009.
54   doi: `10.1093/bioinformatics/btp180 <http://dx.doi.org/10.1093/bioinformatics/btp180>`_
55
56 Disclaimer
57 ==========
58
59 Remember that Hooke is still experimental software!  It has been
60 mostly done to fit the needs of its authors, and there is no guarantee
61 it will do what you need.  However, you can write us/help us improve
62 it so that it does.