doc/install.txt

   1 ****************
   2 Installing Hooke
   3 ****************
   4
   5 Packages
   6 ========
   7
   8 Gentoo
   9 ------
  10
  11 I've packaged Hooke's `wtk` branch for Gentoo.  You need layman_ and
  12 my `wtk overlay`_.  With the `doc` flag enabled, you will also need
  13 the `science overlay`_ (for `dev-python/numpydoc`).  Set up all of
  14 that with::
  15
  16     # emerge -av app-portage/layman
  17     # layman --add science
  18     # layman --add wtk
  19     # emerge -av sci-physics/hooke
  20
  21 .. _layman: http://layman.sourceforge.net/
  22 .. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
  23 .. _science overlay: http://overlays.gentoo.org/proj/science/wiki/en
  24
  25
  26 Dependencies
  27 ============
  28
  29 Hooke is routinely run successfully on Windows and Linux based
  30 systems. It is possible to run it happily on Mac OS X (though install
  31 can be a bit trickier). Technically, Hooke should run wherever the
  32 Python_ programming language is installed.
  33
  34 You'll need the following Python modules:
  35
  36 * Numpy_
  37 * Scipy_
  38 * PyYAML_ (for saving and loading playlists)
  39 * Matplotlib_ (for generating plots)
  40 * wxPython_ (for the GUI)
  41 * FFT_tools_ (for the :py:class:`~hooke.pluging.curve.PowerSpectrumCommand`)
  42
  43 .. _Python: http://www.python.org/
  44 .. _Numpy: http://numpy.scipy.org/
  45 .. _Scipy: http://www.scipy.org/
  46 .. _PyYAML: http://pyyaml.org/
  47 .. _Matplotlib: http://matplotlib.sourceforge.net/
  48 .. _wxPython: http://www.wxpython.org/
  49 .. _FFT_tools: http://pypi.python.org/pypi/FFT-tools
  50
  51
  52 Getting the source
  53 ==================
  54
  55 Hooke_ is available as an Subversion_ repository::
  56
  57     $ svn checkout http://hooke.googlecode.com/svn/trunk/ hooke
  58
  59 There is also a `GUI fork`_ (Rolf Schmidt)::
  60
  61     $ svn checkout http://hooke.googlecode.com/svn/branches/illysam/ hooke
  62
  63 And a `fork`_ versioned in Git_ (W. Trevor King)::
  64
  65     $ git clone git://tremily.us/hooke.git
  66     $ git checkout wtk
  67
  68 There are also periodic bundled releases.  See the homepage for each
  69 fork for details.  For example, get the most recent snapshot of
  70 Trevor's fork in zip form with::
  71
  72      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
  73      $ unzip hooke.zip
  74
  75 .. _Hooke: http://code.google.com/p/hooke/
  76 .. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
  77 .. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
  78 .. _Subversion: http://subversion.tigris.org/
  79 .. _Git: http://git-scm.com/
  80
  81
  82 Installation
  83 ============
  84
  85 Run::
  86
  87     $ python setup.py install
  88
  89 to install Hooke.  Run::
  90
  91     $ python setup.py install --help
  92
  93 to see a list of installation options you may want to configure.
  94
  95 If you install Hooke, you should probably setup a system- or user-wide
  96 configuration file (:doc:`config`), and replace any relative paths
  97 with appropriate absolute paths.  For example::
  98
  99     # Commands for managing a command stack (similar to macros).
 100     [command_stack plugin]
 101     # Directory containing command stack files.
 102     path = resources/command_stack
 103
 104     # wxWindows graphical user interface.
 105     [gui user interface]
 106     # Path to the hooke icon image.
 107     icon image = /usr/share/hooke/doc/img/microscope.ico
 108     # Path to the Hooke splash screen image.
 109     splash screen image = /usr/share/hooke/doc/img/hooke.jpg
 110     # Directory containing perspective files.
 111     perspective path = ~/.hooke/resources/gui/perspective
 112
 113
 114 Running Hooke from the source directory
 115 =======================================
 116
 117 If you like, you can avoid installation by running Hooke directly from
 118 it's source directory::
 119
 120      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
 121      $ unzip hooke.zip
 122      $ cd hooke
 123      $ python bin/hk.py
 124
 125 You may need to give the full path for Python on Windows systems, and
 126 also check that the current working directory (`.`) is in your
 127 `PYTHONPATH`.  See :manpage:`python(1)` for details.