Development

For development conda is recommended.

conda env create -n kmc -f dev-environment.yml
source activate kmc

From here you will have all the necissary dependencies. You can run all the tests, coverage, and style enforcement with the following command.

python setup.py test

Documentation is done with sphinx. You will need to get comfortable with using restructuredText. To update the api documentation you will need to run sphinx-apidoc within the doc directory.