.. RecSQL documentation master file, created by
   sphinx-quickstart on Fri Jul  3 21:35:08 2009.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=================================================
 RecSQL -- simple SQL analysis of python records
=================================================

RecSQL is a hack that allows one to load table-like data records into
an in-memory sqlite_ database for quick and dirty analysis via
SQL_. The :class:`~recsql.SQLarray` class has additional SQL functions
such as ``sqrt`` or ``histogram`` defined. SQL tables can always be
returned as `numpy record arrays`_ so that data can be easily handled in
other packages such as numpy_ or plotted via matplotlib_. Selections
produce new :class:`~recsql.SQLarray` objects.

Most of the Documentation_ is generated from the python doc
strings. See :doc:`INSTALL` for installation instructions.

The package and the documentation are still in flux and any feedback,
bug reports, suggestions and contributions are very welcome. See the
package :doc:`README` for contact details.


.. _Documentation: 
    http://orbeckst.github.com/RecSQL/index.html
.. _sqlite: 
    http://www.sqlite.org/
.. _SQL: 
    http://www.sqlite.org/lang.html
.. _numpy: 
    http://numpy.scipy.org
.. _numpy record arrays: 
    http://www.scipy.org/RecordArrays
.. _matplotlib: 
    http://matplotlib.sourceforge.net


License
-------

This package is Copyright 2007--2012, Oliver Beckstein.

The **RecSQL** package is made available under the terms of the
`GNU Public License v3`_ (or any higher version at your choice). See
the file COPYING.

.. _GNU Public License v3: http://www.gnu.org/licenses/gpl.html


Contents
--------

.. toctree::
   :maxdepth: 2

   README
   INSTALL
   users
   programmers

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`