aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
blob: 84454ff0a7a25a7802c0b887e4886761a510ee03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.. GolemFlavor documentation master file, created by
   sphinx-quickstart on Mon Mar  2 19:03:06 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:github_url: https://github.com/ShiveshM/GolemFlavor

GolemFlavor
===========

GolemFlavor is a Python package for running a Bayesian inference analysis
pipeline using Astrophysical Flavor data taken at the `IceCube Neutrino
Obervatory <https://icecube.wisc.edu/>`_

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   overview
   installation
   examples

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   api
   physics
   statistics

.. toctree::
   :maxdepth: 1
   :caption: Useful links

   GolemFlavor @ GitHub <https://github.com/ShiveshM/GolemFlavor>
   Issue Tracker <https://github.com/ShiveshM/GolemFlavor/issues>

Questions & Bug Reports
-----------------------

If you have a question, would like to propose a new feature, or submit a bug
report, feel free to open up an issue on the `issue tracker on GitHub
<https://github.com/ShiveshM/GolemFlavor/issues>`_.