Update docs to point to Git repository.
[hooke.git] / 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
42 .. _Python: http://www.python.org/
43 .. _Numpy: http://numpy.scipy.org/
44 .. _Scipy: http://www.scipy.org/
45 .. _PyYAML: http://pyyaml.org/
46 .. _Matplotlib: http://matplotlib.sourceforge.net/
47 .. _wxPython: http://www.wxpython.org/
48
49
50 Getting the source
51 ==================
52
53 Hooke_ is available as an Subversion_ repository::
54
55     $ svn checkout http://hooke.googlecode.com/svn/trunk/ hooke
56
57 There is also a `GUI fork`_ (Rolf Schmidt)::
58
59     $ svn checkout http://hooke.googlecode.com/svn/branches/illysam/ hooke
60
61 And a `fork`_ versioned in Git_ (W. Trevor King)::
62
63     $ git clone git://tremily.us/hooke.git
64     $ git checkout wtk
65
66 There are also periodic bundled releases.  See the homepage for each
67 fork for details.  For example, get the most recent snapshot of
68 Trevor's fork in zip form with::
69
70      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
71      $ unzip hooke.zip
72
73 .. _Hooke: http://code.google.com/p/hooke/
74 .. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
75 .. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
76 .. _Subversion: http://subversion.tigris.org/
77 .. _Git: http://git-scm.com/
78
79
80 Installation
81 ============
82
83 Run::
84
85     $ python setup.py install
86
87 to install Hooke.  Run::
88
89     $ python setup.py install --help
90
91 to see a list of installation options you may want to configure.
92
93 If you install Hooke, you should probably setup a system- or user-wide
94 configuration file (:doc:`config`), and replace any relative paths
95 with appropriate absolute paths.  For example::
96
97     # Commands for managing a command stack (similar to macros).
98     [command_stack plugin]
99     # Directory containing command stack files.
100     path = resources/command_stack
101
102     # wxWindows graphical user interface.
103     [gui user interface]
104     # Path to the hooke icon image.
105     icon image = /usr/share/hooke/doc/img/microscope.ico
106     # Path to the Hooke splash screen image.
107     splash screen image = /usr/share/hooke/doc/img/hooke.jpg
108     # Directory containing perspective files.
109     perspective path = ~/.hooke/resources/gui/perspective
110
111
112 Running Hooke from the source directory
113 =======================================
114
115 If you like, you can avoid installation by running Hooke directly from
116 it's source directory::
117
118      $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
119      $ unzip hooke.zip
120      $ cd hooke
121      $ python bin/hk.py
122
123 You may need to give the full path for Python on Windows systems, and
124 also check that the current working directory (`.`) is in your
125 `PYTHONPATH`.  See :manpage:`python(1)` for details.