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     $ hg update wtk
  43
  44 There are also periodic bundled releases.  See the homepage for each
  45 fork for details.  For example, get the most recent snapshot of
  46 Trevor's fork in zip form with::
  47
  48      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
  49      $ unzip hooke.zip
  50
  51 .. _Hooke: http://code.google.com/p/hooke/
  52 .. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
  53 .. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
  54 .. _Subversion: http://subversion.tigris.org/
  55 .. _Mercurial: http://mercurial.selenic.com/
  56
  57
  58 Installation
  59 ============
  60
  61 Run::
  62
  63     $ python setup.py install
  64
  65 to install Hooke.  Run::
  66
  67     $ python setup.py install --help
  68
  69 to see a list of installation options you may want to configure.
  70
  71 If you install Hooke, you should probably setup a system- or user-wide
  72 configuration file (:doc:`config`), and replace any relative paths
  73 with appropriate absolute paths.  For example::
  74
  75     # Commands for managing a command stack (similar to macros).
  76     [command_stack plugin]
  77     # Directory containing command stack files.
  78     path = resources/command_stack
  79
  80     # wxWindows graphical user interface.
  81     [gui user interface]
  82     # Path to the hooke icon image.
  83     icon image = /usr/share/hooke/doc/img/microscope.ico
  84     # Path to the Hooke splash screen image.
  85     splash screen image = /usr/share/hooke/doc/img/hooke.jpg
  86     # Directory containing perspective files.
  87     perspective path = ~/.hooke/resources/gui/perspective
  88
  89
  90 Running Hooke from the source directory
  91 =======================================
  92
  93 If you like, you can avoid installation by running Hooke directly from
  94 it's source directory::
  95
  96      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
  97      $ unzip hooke.zip
  98      $ cd hooke
  99      $ python bin/hk.py
 100
 101 You may need to give the full path for Python on Windows systems, and
 102 also check that the current working directory (`.`) is in your
 103 `PYTHONPATH`.  See :manpage:`python(1)` for details.