/k40gen

standalone background generator for KM3NeT

Primary LanguageCMakeApache License 2.0Apache-2.0

k40gen

standalong background generator for KM3NeT

Installation

On Unix (Linux, OS X)

  • clone this repository
  • pip install ./k40gen

Building the documentation

Documentation for the example project is generated using Sphinx. Sphinx has the ability to automatically inspect the signatures and documentation strings in the extension module to generate beautiful documentation in a variety formats. The following command generates HTML-based reference documentation; for other formats please refer to the Sphinx manual:

  • k40gen/docs
  • make html

Running the tests

Running the tests requires pytest.

py.test .