Skip to content

probcomp/bayeslite

Repository files navigation

Bayeslite

Build Status Anaconda-Server Version Badge Anaconda-Server Installer Badge Anaconda-Server Platform Badge

BQL interpretation and storage for BayesDB. Please see http://probcomp.csail.mit.edu/software/bayesdb for more information.

Installing

The easiest way to install bayeslite is to use the package on Anaconda Cloud. Please follow these instructions.

Expectations

Users and contributors should expect rapidly and dramatically shifting code and behavior at this time.

THIS SOFTWARE SHOULD NOT BE EXPECTED TO TREAT YOUR DATA SECURELY.

Contributing

Our compatibility aim is to work on probcomp machines and members' laptops, and to provide scripts and instructions that make it not too hard to re-create our environments elsewhere. Pulls for polished packaging, broad installability, etc. are not appropriate contributions at this time.

Please run local tests before sending a pull request:

$ ./check.sh

That does not run the complete test suite, only the smoke tests, but is usually good enough. For the full suite:

$ ./check.sh tests shell/tests

Documentation

To build the documentation, which is also available online, install sphinx and then run the following command:

$ make doc

The result will be placed in build/doc, with one subdirectory per output format.

To build only one output format, e.g. HTML because you don't want to install TeX:

$ make html