README.md

Bayesian Supernova Cosmology framework

For the DES Supernova Working Group

Manually building documentation

Documentation available online here.

If you wish to generate the documentation yourself (mainly if you wish to generate a PDF file, which Travis does not do), you will need to follow the below steps.

1. Navigate to doc directory
2. Execute make rst
3. Execute make latexpdf (if you want PDF output)
4. Execute make html (if you want HTML output)
5. Documentation should now be found in the _build directory underneath doc. The top level index.html file will redirect to the appropriate place, just open it up.

Manually running test cases

Please test your build before pushing it. To test your build, simply run:

python setup.py test -a "--cov dessn -v"

If you want to see what statements are not covered up code tests, generate the HTML output via:

python setup.py test -a "--cov dessn -v --cov-report html"