Package: algebraixlib
orphan:algebraixlibWhat Is It?algebraixlibis a library that provides constructs and facilities to harness the fundamentals
of data algebra. Data algebra consists of mathematical constructs that can represent all data, no
matter how it is structured, and the operations on that data. With this, all the advantages of a
mathematically rigorous modeling can be unleashed. See alsoA Beginner’s Introduction to Data Algebra.Getting StartedMake sure you have the required versions of Python and Jupyter Notebook installed (seeRequirementsbelow).Install thealgebraixliblibrary (seeHow to Installbelow).Download theexamplesfrom ourGitHubrepository.Try the Hello_World.ipynb example first.(Alternatively, you can also look at a static version of the notebooks innbviewer; see the
README file in ourexamplesdirectory for direct links. For this you don’t need to install or
download anything. You can also start with the simpler hello_world.py. However, you’ll lose out
on some math and need to read up on it in our documentation atRead the Docs. )Documentation and SupportFind documentation atRead the Docs.Find thepipinstaller onPyPI.Find the source code, the bugtracker and contribute onGitHub.Find tutorials and example code in theexamplesdirectory on GitHub.Post questions about algebraixlib onStack Overflowusing the tag[algebraixlib].Post questions about the mathematics of data algebra onmath.stackexchangeusing the tag[data-algebra].Contact us byemail.See also ourGitHub project page. In addition, there is abookabout data algebra.Detailed InstructionsRequirementsPython: Tested with 3.6.1. Likely to run with Python 3.6.x and later. It may run with earlier
Python 3 versions, but you may run into issues. Does not run with any version of Python before
Python 3.For installing and using multiple versions of Python on the same machine, seeOfficial multiple python versions on the same machine? (Stack Overflow),How to install both Python 2.x and Python 3.x in Windows 7 (Stack Overflow)andA Python Launcher For Windows (Python Insider).Jupyter Notebook: Tested with Jupyter 5.2 (used in the Jupyter notebook tutorials and
examples).SeeJupyter Installationfor instructions how to install the Jupyter notebook
(pip install jupyter).If you don’t want Jupyter in your system environment, you can install it into a virtual
environment (seeCreation of virtual environments).How to InstallIf you already have Python installed and are familiar with installing packages, you can installalgebraixlibwithpip:> pip install algebraixlibAdditional user permissions may be necessary to complete the installation. In such a situation,
other options include installing the package for a single user (in the user’s home directory):> pip install algebraixlib --user <username>or in a virtual environment (seeCreation of virtual environments).You can also manually downloadalgebraixlibfromGitHuborPyPI. To install from a
download, unpack it and run the following command from the top-level source directory (the
directory that contains the file setup.py):> python setup.py install(The same considerations about permissions apply.)Unit TestsThe unit tests require the following libraries to be installed:nosecoverageTo execute the unit tests, download the fileruntests.pyand the directorytestinto any
location on your system, then runruntests.py:> mkdir algebraixlib-test
> cd algebraixlib-test
> svn export https://github.com/AlgebraixData/algebraixlib/trunk/runtests.py
> svn export https://github.com/AlgebraixData/algebraixlib/trunk/test
> python runtests.pyDocumentation BuildThe documentation build requires the following libraries be installed:Sphinx(1.3.2 or later)To run a documentation build, you need a local working copy of our completeGitHubrepository.
Then runbuild.pyin the directorydocs:> mkdir algebraixlib
> cd algebraixlib
> svn export https://github.com/AlgebraixData/algebraixlib/trunk
> cd trunk/docs
> python build.pyLegaleseCopyrightCopyright(c) 2017 Algebraix Data Corporation.Licensealgebraixlibis free software: you can redistribute it and/or modify it under the terms ofversion 3 of the GNU Lesser General Public Licenseas published by theFree Software Foundation. A copy of the GNU Lesser General Public License is published along
withalgebraixlibonGitHub. Otherwise, seeGNU licenses.Warrantyalgebraixlibis 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.