doc/index.txt

   1 Welcome to the Hooke documentation!
   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 .. toctree::
  26    :maxdepth: 2
  27
  28    install.txt
  29    tutorial.txt
  30    hacking.txt
  31    hooke/hooke.txt
  32    doc.txt
  33
  34 Indices and tables
  35 ==================
  36
  37 * :ref:`genindex`
  38 * :ref:`modindex`
  39 * :ref:`search`
  40
  41 Publications
  42 ============
  43
  44 Hooke has been published [1]. Please cite Hooke if you use it.  Let us
  45 know, and we'll link to your paper!
  46
  47
  48 [1] Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.,
  49   "Hooke: an open software platform for force spectroscopy."
  50   Bioinformatics, 2009.
  51   doi: `10.1093/bioinformatics/btp180 <http://dx.doi.org/10.1093/bioinformatics/btp180>`_
  52
  53
  54 Troubleshooting
  55 ===============
  56
  57 If you have troubles in using Hooke:
  58
  59 1. Search the `issue tracker`_.
  60 2. Look at the `trouble shooting wiki page`_.
  61 3. Search the `discussion group`_.
  62 3. Ask a question in the discussion group.
  63 4. File a bug on the issue tracker.
  64
  65 .. _issue tracker: http://code.google.com/p/hooke/issues/list
  66 .. _trouble shooting wiki page:
  67    http://code.google.com/p/hooke/wiki/TroubleShooting
  68 .. _discussion group: http://groups.google.com/group/hookesoftware
  69
  70
  71 Disclaimer
  72 ==========
  73
  74 Remember that Hooke is still experimental software! It has been mostly
  75 done to fit the needs of its authors, and there is no guarantee it
  76 will do what you need. However, you can write us/help us improve it so
  77 that it does. We aim to make of Hooke a little, universal tool that
  78 can help your research.