README

   1 `data_logger` provides tools for simple data management.
   2
   3 The module provides classes for saving and loading data for consistent
   4 communication between independent packages for data aquisition and
   5 processing.  This enables loosely coupled experiment control and
   6 analysis software to still function cleanly and reliably.
   7
   8 General data is pickled using `cPickle`, and there are specialized
   9 methods for saving data in the form of binary strings or dicts of
  10 numpy arrays.
  11
  12 Installation
  13 ============
  14
  15 `data_logger` uses `distutils` for easy installation.  See the
  16 `Hitchhiker's Guide to Packaging`_ for details.  An easy tool based on
  17 distutils is pip_.
  18
  19 .. _Hitchhiker's Guide to Packaging: http://guide.python-distribute.org/
  20 .. _pip: http://pip.openplans.org/
  21
  22
  23 Debian
  24 ------
  25
  26 On Debian-esque systems, the installation procedure should be::
  27
  28   # apt-get intall python-pip
  29   # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
  30
  31 Gentoo
  32 ------
  33
  34 You should probably use the `wtk overlay`_::
  35
  36   # emerge -av app-portage/layman dev-vcs/git
  37   # layman --add wtk
  38   # emerge -av sci-misc/data-logger
  39
  40 .. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
  41
  42 You could also follow the `pip` route, although `pip` isn't in the
  43 Portage tree at the moment (`Gentoo bug 317791`_).  Either::
  44
  45   # emerge -av dev-python/setuptools
  46   # easy_install pip
  47   # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
  48
  49 or use the sunrise_ overlay::
  50
  51   # emerge -av app-portage/layman dev-vcs/subversion
  52   # layman --add sunrise
  53   # emerge -av dev-python/pip
  54   # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
  55
  56 .. _Gentoo bug 317791: http://bugs.gentoo.org/317791
  57 .. _sunrise: http://overlays.gentoo.org/proj/sunrise
  58
  59
  60 Usage
  61 =====
  62
  63 See the tests in `data_logger.py` for simple examples.
  64
  65
  66 Licence
  67 =======
  68
  69 This project is distributed under the General Public License (GPL)
  70 version 3 of the License, or (at your option) any later version.  See
  71 the COPYING file distributed with the code for details.
  72
  73
  74 Author
  75 ======
  76
  77 W. Trevor King
  78 wking@drexel.edu
  79 Copyright 2008-2010