aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShivesh Mandalia <shivesh.mandalia@outlook.com>2020-02-29 00:09:17 +0000
committerShivesh Mandalia <shivesh.mandalia@outlook.com>2020-02-29 00:09:17 +0000
commit11f42e98ae35d317a677ad711decc859a842d893 (patch)
tree288f28fa9e563373c42c897967e3e81c1351e067
parentde279d92b4766b0b8658576dc21bdcb061cc1697 (diff)
downloadGolemFlavor-11f42e98ae35d317a677ad711decc859a842d893.tar.gz
GolemFlavor-11f42e98ae35d317a677ad711decc859a842d893.zip
Update README.md with GolemFlavor logo
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index 17aac19..bb0488b 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
GolemFlavor is a Python package for running an analysis pipeline using
`GolemFit`.
+![GolemFlavor Logo](https://shivesh.org/assets/img/GolemFlavor.png "GolemFlavor")
+
## Installation
GolemFlavor can be installed using `pip`
```
@@ -14,8 +16,8 @@ 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.
+Gaussian likelihood can be used instead for test purposes if this requirement
+is not found.
### Dependencies
@@ -34,7 +36,8 @@ GolemFlavor has the following dependencies:
You can use `pip` to install the above automatically. Note that `PyMultiNest`
requires the `MultiNest` Bayesian inference library, see [the `PyMultiNest`
-documentation for install instructions.](https://johannesbuchner.github.io/PyMultiNest/install.html#prerequisites-for-building-the-libraries)
+documentation]](https://johannesbuchner.github.io/PyMultiNest/install.html#prerequisites-for-building-the-libraries)
+for install instructions.
Additional dependencies:
* [`GolemFit`](https://github.com/IceCubeOpenSource/GolemFit)