reogranise into a python package

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e1ad60b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# GolemFlavor
+
+GolemFlavor is a Python package for running an analysis pipeline using
+`GolemFit`.
+
+## Installation
+GolemFlavor can be installed using `pip`
+```
+pip install git+https://github.com/ShiveshM/flavour_ratio.git
+```
+This installs GolemFlavor, along with all the necessary dependencies such as
+NumPy and SciPy.
+
+GolemFlavor uses the IceCube software [`GolemFit: The HESE
+fitter`](https://github.com/IceCubeOpenSource/GolemFit) to fit with IceCube
+HESE data. Current access is limited to IceCube collaborators. A simple
+Gaussian likelihood can be used for test purposes if this requirement is
+not found.
+
+### Dependencies
+
+GolemFlavor has the following dependencies:
+* [`Python`](https://www.python.org/) 2.7
+* [`NumPy`](http://www.numpy.org/)
+* [`SciPy`](https://www.scipy.org/)
+* [`mpmath`](http://mpmath.org/)
+* [`emcee`](https://emcee.readthedocs.io/en/stable/)
+* [`PyMultiNest`](https://johannesbuchner.github.io/PyMultiNest/)
+* [`tqdm`](https://tqdm.github.io/)
+* [`Shapely`](https://shapely.readthedocs.io/en/latest/manual.html)
+* [`Matplotlib`](https://matplotlib.org/)
+* [`python-ternary`](https://github.com/marcharper/python-ternary)
+* [`GetDist`](https://getdist.readthedocs.io/en/latest/)
+
+You can use `pip` to install the above automatically.
+
+Additional dependencies:
+* [`GolemFit`](https://github.com/IceCubeOpenSource/GolemFit)
+
+## License
+
+[MIT License](LICENSE)
+
+Copyright (c) 2020 Shivesh Mandalia