.. Algebraix Technology Core Library documentation.
   $Id: index.rst 22693 2015-07-28 15:15:37Z gfiedler $
   Copyright Algebraix Data Corporation 2015 - $Date: 2015-07-28 10:15:37 -0500 (Tue, 28 Jul 2015) $

   This file is part of algebraixlib <http://github.com/AlgebraixData/algebraixlib>.

   algebraixlib is free software: you can redistribute it and/or modify it under the terms of
   version 3 of the GNU Lesser General Public License as published by the Free Software Foundation.

   algebraixlib is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
   even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License along with algebraixlib.
   If not, see <http://www.gnu.org/licenses/>.

Algebraix Technology Core Library
=================================

``algebraixlib`` is a library that provides constructs and facilities to harness the fundamentals
of data algebra. You find us:

-   On `PyPI`_. Install as ``pip install algebraixlib`` (or ``pip install algebraixlib --user
    <username>``) or download the package.
-   On `GitHub`_. Here you can get the full sources and use the bug tracker.
-   On Algebraix Data's `GitHub project page`_. Here you find support information.

Also check out our tutorials and example code in the `examples`_ directory on GitHub.

.. _Python API Documentation Guidelines:
    https://algebraix.atlassian.net/wiki/display/projX/Python+API+Documentation+Guidelines
.. _4 Docstring Guidelines:
    https://algebraix.atlassian.net/wiki/display/projX/Python+API+Documentation+Guidelines#PythonAPIDocumentationGuidelines-4DocstringGuidelines
.. _4.1 Markup Instructions:
    https://algebraix.atlassian.net/wiki/display/projX/Python+API+Documentation+Guidelines#PythonAPIDocumentationGuidelines-4.1MarkupInstructions
.. _PyPI:
    http://pypi.python.org/pypi/algebraixlib
.. _GitHub:
    http://github.com/AlgebraixData/algebraixlib
.. _GitHub project page:
    http://algebraixdata.github.io/algebraixlib/
.. _Examples:
    https://github.com/AlgebraixData/algebraixlib/tree/master/examples

API Documentation
-----------------

.. toctree::
   :maxdepth: 3

   _source/algebraixlib/algebraixlib

Algebra Documentation
---------------------

.. toctree::
   :maxdepth: 2

   algebraReference
   algebras
   extension
   set


Indices and Tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :doc:`todo`