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 `data_logger` is basically a really wimpy version of h5py_.  USE h5py
  13 INSTEAD!
  14
  15 .. _h5py: http://code.google.com/p/h5py/
  16
  17 Installation
  18 ============
  19
  20 `data_logger` uses `distutils` for easy installation.  See the
  21 `Hitchhiker's Guide to Packaging`_ for details.  An easy tool based on
  22 distutils is pip_.
  23
  24 .. _Hitchhiker's Guide to Packaging: http://guide.python-distribute.org/
  25 .. _pip: http://pip.openplans.org/
  26
  27
  28 Debian
  29 ------
  30
  31 On Debian-esque systems, the installation procedure should be::
  32
  33   # apt-get intall python-pip
  34   # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
  35
  36 Gentoo
  37 ------
  38
  39 `pip` isn't in the Portage tree at the moment (`Gentoo bug 317791`_),
  40 so either install it with `easy_install`::
  41
  42   # emerge -av dev-python/setuptools
  43   # easy_install pip
  44   # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
  45
  46 or use the sunrise_ overlay::
  47
  48   # emerge -av app-portage/layman dev-vcs/subversion
  49   # layman --add sunrise
  50   # emerge -av dev-python/pip
  51   # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
  52
  53 .. _Gentoo bug 317791: http://bugs.gentoo.org/317791
  54 .. _sunrise: http://overlays.gentoo.org/proj/sunrise
  55
  56
  57 Usage
  58 =====
  59
  60 See the tests in `data_logger.py` for simple examples.
  61
  62
  63 Licence
  64 =======
  65
  66 This project is distributed under the General Public License (GPL)
  67 version 3 of the License, or (at your option) any later version.  See
  68 the COPYING file distributed with the code for details.
  69
  70
  71 Author
  72 ======
  73
  74 W. Trevor King
  75 wking@drexel.edu
  76 Copyright 2008-2010