Commits

Stefan Scherfke committed beac584

More documentation on PyTables

Comments (0)

Files changed (1)

docs/storages.txt

 How to use the storage backends
 ===============================
 
-By default, *Collectors* uses a simple python :class:`list` for each series. You can use other storage backends to handle very large amounts of data or to get a simple *MS Excel* export. You can also add your own storage classes very easily.
+By default, *Collectors* uses a simple python :class:`list` for each series. You
+can use other storage backends to handle very large amounts of data or to get a
+simple *MS Excel* export. You can also add your own storage classes very easily.
 
-All storage classes can be found in submodules of :mod:`collectors.storage` (e.g. :class:`collectors.storage.pytables.PyTables`) but you can also import :class:`~collectors.storage.pytables.PyTables` and :class:`~collectors.storage.excel.Excel` directly from :mod:`collectors.storage`.
+All storage classes can be found in submodules of :mod:`collectors.storage`
+(e.g. :class:`collectors.storage.pytables.PyTables`) but you can also import
+:class:`~collectors.storage.pytables.PyTables` and
+:class:`~collectors.storage.excel.Excel` directly from
+:mod:`collectors.storage`.
 
-You must pass an instance of the storage as keyword argument ``backend`` to a new Collector. Each storage instance should only be used with one Collector instance. ::
+You must pass an instance of the storage as keyword argument ``backend`` to a
+new Collector. Each storage instance should only be used with one Collector
+instance. ::
 
     from collectors import Collector
     from collectors.storage import MyStorage
 PyTables/HDF5
 -------------
 
-`PyTables <http://www.pytables.org/>`_ is not bundled with this package. Instructions follow:
+`PyTables <http://www.pytables.org/>`_ is not bundled with this package.
+Instructions follow:
 
-**Mac OS X (10.6.2 Snow Leopard)**
+**Mac OS X (10.6 Snow Leopard)**
+
+You should not use the precompiled version of *HDF5* because it’s linked against
+*szip*, which is not bundled with *HDF5* and available under a license you might
+not want. So you need to compile it yourself:
+
+1. Download the source from ftp://ftp.hdfgroup.org/HDF5/current/src/
+2. Build and install (*PyTables* will auto detect it if you install it under 
+   ``/usr/local``):
+
+.. sourcecode:: bash
+
+    $ ./configure --prefix=/usr/local
+    $ make
+    $ sudo make install
+    
+3. Finally install *PyTables*
+
+.. sourcecode:: bash
+
+    $ sudo pip install tables
 
 **Ubuntu (9.10 Karmic Koala)**
 
-Ubuntu’s package for PyTables is somehow broken, so you need to build your own. If *gcc* is already installed, you just need to add the development files for python and HDF5 before you can build and install PyTables from `PyPI <http://pypi.python.org/pypi/tables>`_:
+Ubuntu’s package for PyTables is somehow broken, so you need to build your own.
+If *gcc* is already installed, you just need to add the development files for
+python and HDF5 before you can build and install PyTables from `PyPI
+<http://pypi.python.org/pypi/tables>`_:
 
 .. sourcecode:: bash
 
 
 **Windows**
 
-Download the installer from `here <http://www.pytables.org/download/stable/>`_ and execute it. Further information can be found in the `PyTables manual <http://www.pytables.org/docs/manual/ch02.html#binaryInstallationDescr>`_.
+Download the installer from `here <http://www.pytables.org/download/stable/>`_
+and execute it. Further information can be found in the `PyTables manual
+<http://www.pytables.org/docs/manual/ch02.html#binaryInstallationDescr>`_.
 
 Example
 ^^^^^^^