Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 821 Bytes

DEVELOPMENT.md

File metadata and controls

23 lines (12 loc) · 821 Bytes

Getting Started

To start, you will need either Python 2.7 or Python 3.5.2 or later

Building the Documentation

To build the documentation, execute the following command at the command line in the directory this file is contained:

make documentation

You will need pdflatex, pandoc, jupyter and sphinx installed.

If this is successful, you can view a PDF of the documentation in the directory:

./doc/build/latex/HTTM.pdf

Running Tests

To start, make sure the virtualenv python module is installed.

To run the unit tests for this software, execute the following command at the command line in the directory this file is contained:

make test