doc/install.txt

   1 ****************
   2 Installing Hooke
   3 ****************
   4
   5 Dependencies
   6 ============
   7
   8 Hooke is routinely run successfully on Windows and Linux based
   9 systems. It is possible to run it happily on Mac OS X (though install
  10 can be a bit trickier). Technically, Hooke should run wherever the
  11 Python_ programming language is installed.
  12
  13 You'll need the following Python modules:
  14
  15 * Numpy_
  16 * Scipy_
  17 * PyYAML_ (for saving and loading playlists)
  18 * Matplotlib_ (for generating plots)
  19 * wxPython_ (for the GUI)
  20
  21 .. _Python: http://www.python.org/
  22 .. _Numpy: http://numpy.scipy.org/
  23 .. _Scipy: http://www.scipy.org/
  24 .. _PyYAML: http://pyyaml.org/
  25 .. _Matplotlib: http://matplotlib.sourceforge.net/
  26 .. _wxPython: http://www.wxpython.org/
  27
  28 Getting the source
  29 ==================
  30
  31 Hooke_ is available as an Subversion_ repository::
  32
  33     $ svn checkout http://hooke.googlecode.com/svn/trunk/ hooke
  34
  35 There is also a `GUI fork`_ (Rolf Schmidt)::
  36
  37     $ svn checkout http://hooke.googlecode.com/svn/branches/illysam/ hooke
  38
  39 And a `fork`_ versioned in Mercurial_ (W. Trevor King)::
  40
  41     $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/ hooke
  42
  43 There are also periodic bundled releases.  See the homepage for each
  44 fork for details.  For example, get the most recent snapshot of
  45 Trevor's fork in zip form with::
  46
  47      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
  48      $ unzip hooke.zip
  49
  50 .. _Hooke: http://code.google.com/p/hooke/
  51 .. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
  52 .. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
  53 .. _Subversion: http://subversion.tigris.org/
  54 .. _Mercurial: http://mercurial.selenic.com/
  55
  56
  57 Installation
  58 ============
  59
  60 Run::
  61
  62     $ python setup.py install
  63
  64 to install Hooke.  Run::
  65
  66     $ python setup.py install --help
  67
  68 to see a list of installation options you may want to configure.
  69
  70 Running Hooke from the source directory
  71 =======================================
  72
  73 If you like, you can avoid installation by running Hooke directly from
  74 it's source directory::
  75
  76      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
  77      $ unzip hooke.zip
  78      $ cd hooke
  79      $ python bin/hk.py
  80
  81 You may need to give the full path for Python on Windows systems, and
  82 also check that the current working directory (`.`) is in your
  83 `PYTHONPATH`.  See :manpage:`python(1)` for details.