test/data/vclamp_jpk/README: Document sample versions

[hooke.git] / doc / install.txt

diff --git a/doc/install.txt b/doc/install.txt
index 8cfbe5bff5c50e2c9b1fab5119b1ce93061e777f..f81b07f473d1eb8e06636d701d7b05def524196f 100644 (file)
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -2,6 +2,27 @@
 Installing Hooke
 ****************
 
 Installing Hooke
 ****************
 

+Packages
+========
+
+Gentoo
+------
+
+I've packaged Hooke's `wtk` branch for Gentoo.  You need layman_ and
+my `wtk overlay`_.  With the `doc` flag enabled, you will also need
+the `science overlay`_ (for `dev-python/numpydoc`).  Set up all of
+that with::
+
+    # emerge -av app-portage/layman
+    # layman --add science
+    # layman --add wtk
+    # emerge -av sci-physics/hooke
+
+.. _layman: http://layman.sourceforge.net/
+.. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
+.. _science overlay: http://overlays.gentoo.org/proj/science/wiki/en
+
+

 Dependencies
 ============
 
 Dependencies
 ============
 


@@ -14,14 +35,19 @@ You'll need the following Python modules:
 
 * Numpy_
 * Scipy_
 
 * Numpy_
 * Scipy_

+* PyYAML_ (for saving and loading playlists)

 * Matplotlib_ (for generating plots)
 * wxPython_ (for the GUI)
 * Matplotlib_ (for generating plots)
 * wxPython_ (for the GUI)

+* FFT_tools_ (for the :py:class:`~hooke.pluging.curve.PowerSpectrumCommand`)

 
 

+.. _Python: http://www.python.org/

 .. _Numpy: http://numpy.scipy.org/
 .. _Scipy: http://www.scipy.org/
 .. _Numpy: http://numpy.scipy.org/
 .. _Scipy: http://www.scipy.org/

-.. _Python: http://www.python.org/
+.. _PyYAML: http://pyyaml.org/

 .. _Matplotlib: http://matplotlib.sourceforge.net/
 .. _wxPython: http://www.wxpython.org/
 .. _Matplotlib: http://matplotlib.sourceforge.net/
 .. _wxPython: http://www.wxpython.org/

+.. _FFT_tools: http://pypi.python.org/pypi/FFT-tools
+

 
 Getting the source
 ==================
 
 Getting the source
 ==================


@@ -34,9 +60,10 @@ There is also a `GUI fork`_ (Rolf Schmidt)::
 
     $ svn checkout http://hooke.googlecode.com/svn/branches/illysam/ hooke
 
 
     $ svn checkout http://hooke.googlecode.com/svn/branches/illysam/ hooke
 

-And a `fork`_ versioned in Mercurial_ (W. Trevor King)::
+And a `fork`_ versioned in Git_ (W. Trevor King)::

 
 

-    $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hooke/ hooke
+    $ git clone git://tremily.us/hooke.git
+    $ git checkout wtk

 
 There are also periodic bundled releases.  See the homepage for each
 fork for details.  For example, get the most recent snapshot of
 
 There are also periodic bundled releases.  See the homepage for each
 fork for details.  For example, get the most recent snapshot of


@@ -49,7 +76,7 @@ Trevor's fork in zip form with::
 .. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
 .. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
 .. _Subversion: http://subversion.tigris.org/
 .. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
 .. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
 .. _Subversion: http://subversion.tigris.org/

-.. _Mercurial: http://mercurial.selenic.com/
+.. _Git: http://git-scm.com/

 
 
 Installation
 
 
 Installation


@@ -65,16 +92,35 @@ to install Hooke.  Run::
 
 to see a list of installation options you may want to configure.
 
 
 to see a list of installation options you may want to configure.
 

+If you install Hooke, you should probably setup a system- or user-wide
+configuration file (:doc:`config`), and replace any relative paths
+with appropriate absolute paths.  For example::
+
+    # Commands for managing a command stack (similar to macros).
+    [command_stack plugin]
+    # Directory containing command stack files.
+    path = resources/command_stack
+
+    # wxWindows graphical user interface.
+    [gui user interface]
+    # Path to the hooke icon image.
+    icon image = /usr/share/hooke/doc/img/microscope.ico
+    # Path to the Hooke splash screen image.
+    splash screen image = /usr/share/hooke/doc/img/hooke.jpg
+    # Directory containing perspective files.
+    perspective path = ~/.hooke/resources/gui/perspective
+
+

 Running Hooke from the source directory
 =======================================
 
 If you like, you can avoid installation by running Hooke directly from
 it's source directory::
 
 Running Hooke from the source directory
 =======================================
 
 If you like, you can avoid installation by running Hooke directly from
 it's source directory::
 

-     $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/git/git.php?p=hooke.git&dl=zip&h=HEAD
+     $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip

      $ unzip hooke.zip
      $ cd hooke
      $ unzip hooke.zip
      $ cd hooke

-     $ python bin/hooke
+     $ python bin/hk.py

 
 You may need to give the full path for Python on Windows systems, and
 also check that the current working directory (`.`) is in your
 
 You may need to give the full path for Python on Windows systems, and
 also check that the current working directory (`.`) is in your