test/data/vclamp_jpk/README: Document sample versions

[hooke.git] / doc / gui.txt

diff --git a/doc/gui.txt b/doc/gui.txt
index 7459a194267973123d16958fd9a29694d8d5897c..c6b8e08bf1cedff70f3e016f4fd7efa9909eb73b 100644 (file)
--- a/doc/gui.txt
+++ b/doc/gui.txt
@@ -4,7 +4,11 @@ The GUI interface
 
 Orignially by Rolf Schmidt <rschmidt@alcor.concordia.ca>.
 
-Enable by selecting `gui` in your :file:`hooke.cfg`.::
+Run the GUI with::
+
+    $ ./bin/hk.py --ui gui
+
+Alternatively, select `gui` in your config file (see :doc:`config`)::
 
     [user interfaces]
     command line = False
@@ -22,7 +26,6 @@ key toggles the visibility of the panel):
 * Output (`F8`)
 * Playlists (`F9`)
 * Properties (`F10`)
-* Results (`F11`)
 
 .. image:: img/gui_screenshot.jpg
 
@@ -43,12 +46,35 @@ the `y column(s)` button and checking interesting columns.  We suggest
 you stick to columns with a single unit, and not try and dispay, for
 example, both meters and newtons on the same y axis.
 
+You can move about the plot using its navigation toolbar.  See the
+`Matplotlib manual`_ for details.
+
+.. _Matplotlib manual:
+  http://matplotlib.sourceforge.net/users/navigation_toolbar.html
+
+You can measure distances and forces directly in the plot.  If you
+want to know the coordinates of a single point, left click on it.  The
+index and coordinates of the nearest data point will be displayed in
+the status bar along with the x and y coordinates of your click.
+
+To find the distance between two points, just issue the command
+``delta``.  You will be asked to click two points.  When you click a
+point, a blue dot should appear.  When you click the second point, the
+distances will appear in the output panel.  Hooke automatically
+adjusts the position of the clicked point to the nearest point in the
+graph, so you will be always measuring distances and forces between
+points in the graph.
+
+.. todo:: Implement blue dots and click handler.
+
 Folders
 =======
 Here you can navigate your file system and double click on a saved
 playlist to open it.  You can change the initial folder by modifying
 `workdir` in the `preferences` (core plugin).
 
+.. todo:: Implement folders panel.
+
 Playlists
 =========
 You can manage several playlists in this window.  As the GUI is rather
@@ -92,17 +118,6 @@ floating point values.
 .. todo:: Document new, non-PropGrid
   :mod:`~hooke.ui.gui.panel.propertyeditor`.
 
-Results
-=======
-The results from the `autopeak` or `multidistance` commands are
-displayed here.  Initially, all results are checked (i.e. visible).  If
-you want to hide a result, simply uncheck it.  Hidden curves will not
-be exported either.  You can only display one type of fit result (WLC,
-FJC, etc.) at a time and you can switch between result types (results
-plugin - show_results).
-
-.. todo:: Results panel not yet re-implemented.
-
 Output
 ======
 The Output window serves as a log where pertinent information is
@@ -129,8 +144,6 @@ Hooke's GUI will remember the size and position of the main window
 panels any which way you like and save this arrangement as a
 perspective.
 
-.. todo:: Actually write new properties to the config file on GUI exit.
-
 .. image:: img/gui_perspective.jpg
 
 Hooke will always start with the last used perspective and you can
@@ -172,3 +185,13 @@ The :doc:`autopeak` tutorial is also applicable.  You need to setup the
 type of fit you want to use: in the Properties of the autopeak command
 (autopeak plugin) select `WLC`, `FJC` or `FJC_PEG` from the dropdown
 list for the `polymer model` argument of `polymer fit`.
+
+Fast curve reviewing and saving
+===============================
+.. todo:: Update curve review tutorial section.
+
+When automatic routines are not good enough to filter your data, use
+``review`` command to cycle through your playlist presenting ten
+curves in the same graph.  You can then enter the numbers of the
+interesting curves and automatically save a copy of them into another
+directory.