A number of minor documentation cleanups.
[hooke.git] / doc / hacking.txt
1 *************
2 Hacking Hooke
3 *************
4
5 .. toctree::
6    :maxdepth: 2
7
8    testing.txt
9
10 Architecture
11 ============
12
13 To clean up the internals, were going to go crazy on the
14 object-oriented front, and try to keep the core functionality free of
15 any dependencies other than the `Python Standard Library`_ and Numpy_
16 / Scipy_.
17
18 .. _Python Standard Library: http://docs.python.org/library/
19 .. _Numpy: http://numpy.scipy.org/
20 .. _Scipy: http://www.scipy.org/
21
22 To make a responsive user interface in parallel with data processing
23 and possible GUIs, we'll use Python's multiprocessing_ and queue_
24 modules.  These modules are both new in Python 2.6, but 2.6 usage is
25 becoming fairly widespread.  Certainly more widespread than any
26 alternative queue module that I know of.  Since we're leveraging the
27 power of the standard library, we use configparser_ for the config
28 files.
29
30 .. _multiprocessing: http://docs.python.org/dev/library/multiprocessing.html
31 .. _queue: http://docs.python.org/library/queue.html
32 .. _configparser: http://docs.python.org/library/configparser.html
33
34 On the testing side, the need to stick to the standard library relaxes
35 (developers can install extra packages), so we can use nose_.  See
36 the Testing_ section for more information.
37
38 .. _nose: http://somethingaboutorange.com/mrl/projects/nose/0.11.3/
39 .. _Testing: testing.txt