algebraixlib 1.1

A data algebra library

What Is It?

algebraixlib is a library that provides constructs and facilities to harness the fundamentals of data algebra.

Requirements

Python 3.4.3 or later. IPython Notebook 3.2 or later for the IPython notebook tutorials and examples.

How to Install

If you already have Python installed and are familiar with installing packages, you can get algebraixlib with pip:

> pip install algebraixlib

Additional user permissions may be necessary to complete the installation. In such a situation other options include installing the package to the home directory:

> pip install algebraixlib --user <username>

or in a virtual environment, see Creation of virtual environments.

You can also manually download algebraixlib from GitHub or PyPI. To install from a download, unpack it and run the following from the top-level source directory using the terminal:

> python setup.py install

Unit Tests

The unit tests require the following libraries be installed:

• nose

• coverage

To execute the unit tests, from the console, in the algebraixlib directory, use the command:

> python runtests.py

Document Build

The document builds require the following libraries be installed:

• Sphinx (1.3 or later)

To execute the document builds, from the console, in the algebraixlib/docs directory, use command:

> python build.py

Documentation and Support

• Find documentation at Read the Docs.

• Find the library on PyPI.

• Find the library, the bugtracker and contribute on GitHub.

• Find tutorials and example code in the examples directory on GitHub.

• Post questions about algebraixlib on Stack Overflow using the tag [algebraixlib].

• Post questions about the mathematics of data algebra on math.stackexchange using the tag [data-algebra].

• Contact us at email.

See also our GitHub project page. In addition, there is a book forthcoming about data algebra.

Copyright

Copyright(c) 2015 Algebraix Data Corporation.

License

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. A copy of the GNU Lesser General Public License is published along with algebraixlib on GitHub. Otherwise, see GNU licenses.

Warranty

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.