Information for developers

Information for developers

This page describes how to edit the code and run the tests.

There are numerous dependencies, all of which need to be installed in order for the tests to pass. The recommended method is to use a virtual machine and vagrant to do this. There is a directory in this repository called Vagrant, which contains a VagrantFile to set up the VM. The hard work is done by a script scripts/install_dependencies.sh.

Note: you will probably want to change the lines in VagrantFile that mount directories from the host inside the VM.

Set up, start, and log into the VM by running these commands from the (vagrant/) directory:

vagrant up
vagrant ssh

Then inside the VM, clone this repository, change to the python/ directory in the repository and run the tests with:

python3 setup.py test

The tests should all pass!

If you edit the code, please modify existing tests or add new ones as is relevant.