Contributing

Reporting Issues

Report issues here

Branch and submit a pull request. Try to keep it PEP8.

Unit tests are in the tests/ directory and can be run by nosetests -v

To run analysis use the benchmark flag with a command:

python -m boxel.boxel --benchmark COMMAND

This will ouput benchmark file in benchmarks/ named as profileN.txt with N being the largest number in the directory. To view results:

cprofile -f benchmarks/<FILE>.txt

Then visit localhost:4000 in a browser.