README

   1 .. -*- coding: utf-8 -*-
   2
   3 What it is
   4 ==========
   5
   6 It is a software for the (semiautomatic) analysis and filtering of
   7 force curves. Force curves are the output of an analytical technique
   8 called force spectroscopy. A force spectroscopy experiment usually
   9 requires the analysis of thousands of force curves at a time. As of
  10 today, there is no standard, free software for the analysis of force
  11 curves. Hooke aims to solve that.
  12
  13
  14 What it does
  15 ============
  16
  17 * View, annotate, measure force curves
  18 * Worm-like chain and freely-jointed chain fit of force peaks
  19 * Automatic convolution-based filtering of empty curves
  20 * Automatic fit and measurement of multiple force peaks
  21 * Handles force-clamp force experiments (experimental)
  22 * It is extensible by users by mean of plugins and drivers
  23
  24 See `Hooke's Google Code homepage`_ for more details.
  25
  26
  27 How it works
  28 ============
  29
  30 See the ``doc/tutorial.txt`` file distributed with Hooke, or the
  31 `online docs`__.
  32
  33 __ docs_
  34
  35 Where it's published
  36 ====================
  37
  38 Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.
  39 "Hooke: an open software platform for force spectroscopy."
  40 Bioinformatics, 2009 25(11):1428-1430.
  41 doi:10.1093/bioinformatics/btp180
  42
  43 Please cite Hooke if you use it.
  44
  45
  46 Troubleshooting
  47 ===============
  48
  49 If you have troubles in using it, before throwing it in the trash:
  50
  51 1. Search the `issue tracker`_.
  52 2. Look at the `troubleshooting wiki page`_.
  53 3. Search the `discussion group`_.
  54 4. Ask a question in the discussion group.
  55 5. File a bug on the issue tracker.
  56
  57
  58 Disclaimer
  59 ==========
  60
  61 Remember that Hooke is still experimental software! It has been mostly
  62 done to fit the needs of its authors, and there is no guarantee it
  63 will do what you need. However, you can write us/help us improve it so
  64 that it does. We aim to make of Hooke a robust tool that can help your
  65 research.
  66
  67
  68 Source
  69 ======
  70
  71 Hooke is available as a Git_ repository::
  72
  73     $ git clone git://tremily.us/hooke.git
  74
  75 See the docs_ for installation details.
  76
  77
  78 Licensing
  79 =========
  80
  81 Hooke is released under the GNU Lesser General Public License, either
  82 version 3 of the License (``COPYING`` and ``COPYING.LESSER``), or (at
  83 your option) any later version.
  84
  85 .. _Hooke's Google Code homepage: http://code.google.com/p/hooke/
  86 .. _docs: http://hooke.tremily.us/
  87 .. _issue tracker: http://code.google.com/p/hooke/issues/list
  88 .. _troubleshooting wiki page:
  89   http://code.google.com/p/hooke/wiki/TroubleShooting
  90 .. _discussion group: http://groups.google.com/group/hookesoftware
  91 .. _Git: http://git-scm.com/