README

   1 What it is
   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 `Hooke's Google Code homepage`_ for more details.
  23
  24 .. _Hooke's Google Code homepage: http://code.google.com/p/hooke/
  25
  26
  27 How it works
  28 ============
  29
  30 See the doc/tutorial.txt file distributed with Hooke, or the `online
  31 docs`_.
  32
  33 .. _online docs: http://www.physics.drexel.edu/~wking/rsrch/hooke/
  34
  35
  36 Where it's published
  37 ====================
  38
  39 Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.
  40 "Hooke: an open software platform for force spectroscopy."
  41 Bioinformatics, 2009 25(11):1428-1430.
  42 doi:10.1093/bioinformatics/btp180
  43
  44 Please cite Hooke if you use it.
  45
  46
  47 Troubleshooting
  48 ===============
  49
  50 If you have troubles in using it, before throwing it in the trash:
  51
  52 1. Search the `issue tracker
  53    <http://code.google.com/p/hooke/issues/list>`_.
  54 2. Look at the `troubleshooting wiki page
  55    <http://code.google.com/p/hooke/wiki/TroubleShooting>`_.
  56 3. Search the `discussion group
  57    <http://groups.google.com/group/hookesoftware>`_.
  58 4. Ask a question in the discussion group.
  59 5. File a bug on the issue tracker.
  60
  61
  62 Disclaimer
  63 ==========
  64
  65 Remember that Hooke is still experimental software! It has been mostly
  66 done to fit the needs of its authors, and there is no guarantee it
  67 will do what you need. However, you can write us/help us improve it so
  68 that it does. We aim to make of Hooke a robust tool that can help your
  69 research.
  70
  71
  72 Source
  73 ======
  74
  75 Hooke is available as a Mercurial_ repository::
  76
  77     $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hooke/
  78
  79 See the docs_ for installation details.
  80
  81
  82 Licensing
  83 =========
  84
  85 Hooke is released under the GNU Lesser General Public License, either
  86 version 3 of the License (COPYING and COPYING.LESSER), or (at your
  87 option) any later version.
  88
  89
  90 .. _Mercurial: http://mercurial.selenic.com/
  91 .. _docs: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Hooke/html/