Installation

Note

RLTK only supports Python 3 and it's tested under Python 3.6.

Prerequisites

There are some system level packages need to be installed first.

Using pip to install:

pip install rltk

If you want to update RLTK:

pip install -U rltk

Generally, it's recommended to install packages in a virtual environment:

virtualenv rltk_env
source activate rltk_env
pip install rltk

Note

If you are using Mac and installed LevelDB by HomeBrew, please make sure that plyvel refers to correct library file while installing:

pip uninstall plyvel
CFLAGS='-mmacosx-version-min=10.7 -stdlib=libc++' pip install --no-cache-dir plyvel

The other way to install RLTK is to clone from GitHub repository and build it from source:

git clone https://github.com/usc-isi-i2/rltk.git
cd rltk

virtualenv rltk_env
source activate rltk_env
pip install -e .

RLTK uses pytest for unit tests. To run them, simply do following command from the root of rltk package:

pytest

If you need more detailed information, do:

pytest -v --color=yes

Additional dependencies for building documentation should be installed first:

pip install -r requirements_docs.txt

Documentation is powered by Sphinx , to generate it on your local, please run:

cd docs
make html # the generated doc is located at _build/html/index.html