Installation

Note

Pyrallel supports Python 3 and it’s tested under Python 3.4+.

pip

Using pip to install:

pip install pyrallel.lib

If you want to update installed Pyrallel:

pip install -U pyrallel.lib

Development installation

Install from source

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

virtualenv pyrallel_env
source activate pyrallel_env
pip install -r requirements.txt
pip install -r requreiments-dev.txt
pip install -e .

Run tests

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

pytest

If you need more detailed information, do:

pytest -v --color=yes

Build documentation

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