Moved LICENSE -> COPYING. A more traditional name
[data_logger.git] / README
1 This package provides simple data logging/loading classes for consist
2 data managing.  General data is pickled using cPickle, and there are
3 specialized methods for saving data in the form of binary strings or
4 dicts of numpy arrays.
5
6 == Installation ==
7
8 data_logger uses `setuptools' for installation.  Setuptools is basically
9 an extension of the standard Python distutils package which supports
10 automatic package dependency tracking.  The installation procedure
11 should be (on Debian-esque systems)
12   # apt-get intall python-setuptools python-numpy-dev
13   # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
14
15 There is one speedbump you might run into:
16   * an outdated version of easy_install (see ez_setup.py section)
17
18 ** ez_setup.py
19
20 This package bundles
21   http://peak.telecommunity.com/dist/ez_setup.py
22 to bootstrap setuputils installation on your machine (if neccessary).
23
24 If the bootstrapping doesn't work, you may need to install a current version
25 of setuptools.  On Debian-based systems `apt-get install python-setuptools'.
26 Once you have *some* version of setuptools, upgrade with
27   easy_install -U setuptools
28
29 For more information see
30   http://peak.telecommunity.com/DevCenter/EasyInstall
31   http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
32
33
34 == Usage ==
35
36 See the tests in data_logger.py for simple examples.
37
38
39 == Licence ==
40
41 This project is distributed under the General Public License (GPL)
42 See the COPYING file distributed with the code.
43
44
45 == Author ==
46
47 W. Trevor King
48 wking@drexel.edu
49 Copyright 2008