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