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 * Matplotlib_ (for generating plots)
  18 * wxPython_ (for the GUI)
  19
  20 .. _Numpy: http://numpy.scipy.org/
  21 .. _Scipy: http://www.scipy.org/
  22 .. _Python: http://www.python.org/
  23 .. _Matplotlib: http://matplotlib.sourceforge.net/
  24 .. _wxPython: http://www.wxpython.org/
  25
  26 Getting the source
  27 ==================
  28
  29 Hooke_ is available as an Subversion_ repository::
  30
  31     $ svn checkout http://hooke.googlecode.com/svn/trunk/ hooke
  32
  33 There is also a `GUI fork`_ (Rolf Schmidt)::
  34
  35     $ svn checkout http://hooke.googlecode.com/svn/branches/illysam/ hooke
  36
  37 And a `fork`_ versioned in Mercurial_ (W. Trevor King)::
  38
  39     $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/ hooke
  40
  41 There are also periodic bundled releases.  See the homepage for each
  42 fork for details.  For example, get the most recent snapshot of
  43 Trevor's fork in zip form with::
  44
  45      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
  46      $ unzip hooke.zip
  47
  48 .. _Hooke: http://code.google.com/p/hooke/
  49 .. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
  50 .. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
  51 .. _Subversion: http://subversion.tigris.org/
  52 .. _Mercurial: http://mercurial.selenic.com/
  53
  54
  55 Installation
  56 ============
  57
  58 Run::
  59
  60     $ python setup.py install
  61
  62 to install Hooke.  Run::
  63
  64     $ python setup.py install --help
  65
  66 to see a list of installation options you may want to configure.
  67
  68 Running Hooke from the source directory
  69 =======================================
  70
  71 If you like, you can avoid installation by running Hooke directly from
  72 it's source directory::
  73
  74      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
  75      $ unzip hooke.zip
  76      $ cd hooke
  77      $ python bin/hk.py
  78
  79 You may need to give the full path for Python on Windows systems, and
  80 also check that the current working directory (`.`) is in your
  81 `PYTHONPATH`.  See :manpage:`python(1)` for details.