README.md 718 Bytes
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
k40gen
==============

standalong background generator for KM3NeT


Installation
------------

**On Unix (Linux, OS X)**

 - clone this repository
Roel Aaij's avatar
Roel Aaij committed
13
 - `pip install ./k40gen`
14
15
16
17
18
19
20
21
22
23

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:

Roel Aaij's avatar
Roel Aaij committed
24
 - `k40gen/docs`
25
26
27
28
29
30
31
32
33
34
35
 - `make html`


Running the tests
-----------------

Running the tests requires `pytest`.

```bash
py.test .
```