test/data/vclamp_jpk/README: Document sample versions

[hooke.git] / doc / install.txt

diff --git a/doc/install.txt b/doc/install.txt
index 270f99ea53dc93dd42eb82bccfafbc95e2385781..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
 ============
 


@@ -17,6 +38,7 @@ You'll need the following Python modules:
 * PyYAML_ (for saving and loading playlists)
 * Matplotlib_ (for generating plots)
 * wxPython_ (for the GUI)
 * PyYAML_ (for saving and loading playlists)
 * 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/
 
 .. _Python: http://www.python.org/
 .. _Numpy: http://numpy.scipy.org/


@@ -24,6 +46,8 @@ You'll need the following Python modules:
 .. _PyYAML: http://pyyaml.org/
 .. _Matplotlib: http://matplotlib.sourceforge.net/
 .. _wxPython: http://www.wxpython.org/
 .. _PyYAML: http://pyyaml.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
 ==================


@@ -36,10 +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/hgwebdir.cgi/hooke/ hooke
-    $ hg update wtk
+    $ 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


@@ -52,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