Installation

The following packages are required:

• NumPy

• Sphinx

• Python Pandas

• PyTorch

• Coverage.py

You can install there as usual with pip.

pip install -r requirements.txt

Installation of the package is done via setuptools

python setup.py

Run tests

The is a series of tests to verify the implementation. You can executed these by running the script execute_tests_with_coverage.sh.

Generate documentation

You will need Sphinx in order to generate the API documentation. Assuming that Sphinx is already installed on your machine execute the following commands (see also Sphinx tutorial).

sphinx-quickstart docs
sphinx-build -b html docs/source/ docs/build/html