contributing.md

Contributing to themis-ml

Development Environment

Create a themis-ml development environment as follows:

• install Anaconda or miniconda
• clone the repository
• cd into the themis-ml source directory

Create a new virtual environment with conda (currently development in Python 2.7 and 3.6 are supported):

# setting up
conda create -n themis_ml_dev python=<version> --file environment_dev.yml

# to update your current environment
conda env update -n themis_ml_dev --file environment_dev.yml

To work in this environment, Mac OSX Linux users should:

source activate themis_ml_dev

# to deactivate:
source deactivate

Optionally, you can use direnv to automatically load the themis_ml_dev virtual environment whenever you cd into the source repository.

# on MacOSX
brew install direnv

# in themis-ml source directory
direnv allow .