-This package provides simple data logging/loading classes for consist
-data managing. General data is pickled using cPickle, and there are
-specialized methods for saving data in the form of binary strings or
-dicts of numpy arrays.
+`data_logger` provides tools for simple data management.
-== Installation ==
+The module provides classes for saving and loading data for consistent
+communication between independent packages for data aquisition and
+processing. This enables loosely coupled experiment control and
+analysis software to still function cleanly and reliably.
-data_logger uses `setuptools' for installation. Setuptools is basically
-an extension of the standard Python distutils package which supports
-automatic package dependency tracking. The installation procedure
-should be (on Debian-esque systems)
- # apt-get intall python-setuptools python-numpy-dev
- # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ FFT_tools
+General data is pickled using `cPickle`, and there are specialized
+methods for saving data in the form of binary strings or dicts of
+numpy arrays.
-There is one speedbump you might run into:
- * an outdated version of easy_install (see ez_setup.py section)
+`data_logger` is basically a really wimpy version of h5py_. USE h5py
+INSTEAD!
-** ez_setup.py
+.. _h5py: http://code.google.com/p/h5py/
-This package bundles
- http://peak.telecommunity.com/dist/ez_setup.py
-to bootstrap setuputils installation on your machine (if neccessary).
+Installation
+============
-If the bootstrapping doesn't work, you may need to install a current version
-of setuptools. On Debian-based systems `apt-get install python-setuptools'.
-Once you have *some* version of setuptools, upgrade with
- easy_install -U setuptools
+`data_logger` uses `distutils` for easy installation. See the
+`Hitchhiker's Guide to Packaging`_ for details. An easy tool based on
+distutils is pip_.
-For more information see
- http://peak.telecommunity.com/DevCenter/EasyInstall
- http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
+.. _Hitchhiker's Guide to Packaging: http://guide.python-distribute.org/
+.. _pip: http://pip.openplans.org/
-== Usage ==
+Debian
+------
-See the tests in data_logger.py for simple examples.
+On Debian-esque systems, the installation procedure should be::
+ # apt-get intall python-pip
+ # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
-== Licence ==
+Gentoo
+------
+
+`pip` isn't in the Portage tree at the moment (`Gentoo bug 317791`_),
+so either install it with `easy_install`::
+
+ # emerge -av dev-python/setuptools
+ # easy_install pip
+ # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
+
+or use the sunrise_ overlay::
+
+ # emerge -av app-portage/layman dev-vcs/subversion
+ # layman --add sunrise
+ # emerge -av dev-python/pip
+ # pip install -f http://www.physics.drexel.edu/~wking/code/python/ data_logger
+
+.. _Gentoo bug 317791: http://bugs.gentoo.org/317791
+.. _sunrise: http://overlays.gentoo.org/proj/sunrise
+
+
+Usage
+=====
+
+See the tests in `data_logger.py` for simple examples.
+
+
+Licence
+=======
This project is distributed under the General Public License (GPL)
-See the LICENSE file distributed with the code.
+version 3 of the License, or (at your option) any later version. See
+the COPYING file distributed with the code for details.
-== Author ==
+Author
+======
W. Trevor King
wking@drexel.edu
-Copyright 2008
+Copyright 2008-2010
projects / data_logger.git / blobdiff