From 072d152e85f001350f0d03e0b5e26434e82422c6 Mon Sep 17 00:00:00 2001 From: Leander Fischer Date: Wed, 24 Apr 2024 14:07:11 +0200 Subject: [PATCH] Update README.md add urls to badges and some text modifications --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7a2d6fc7a..0e713a5b3 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -![Unit Tests](https://img.shields.io/github/actions/workflow/status/icecube/pisa/.github/workflows/pythonpackage.yml?label=unit%20tests) -![Pull Requests](https://img.shields.io/github/issues-pr/icecube/pisa) +[![Unit Tests](https://img.shields.io/github/actions/workflow/status/icecube/pisa/.github/workflows/pythonpackage.yml?label=unit%20tests)](https://github.com/icecube/pisa/actions/workflows/pythonpackage.yml) +[![Pull Requests](https://img.shields.io/github/issues-pr/icecube/pisa)](https://github.com/icecube/pisa/pulls) ![Repo Stars](https://img.shields.io/github/stars/icecube/pisa?style=social) [Introduction](pisa/README.md) | @@ -14,22 +14,23 @@ PISA is a software written to analyze the results (or expected results) of an experiment based on Monte Carlo simulation. -In particular, PISA was written by and for the IceCube Collaboration for analyses employing the [IceCube Neutrino Observatory](https://icecube.wisc.edu/), including the [DeepCore](https://arxiv.org/abs/1109.6096) and the proposed [PINGU](https://arxiv.org/abs/1401.2046) low-energy in-fill arrays. -However, any such experiment—or any experiment at all—can make use of PISA for analyzing expected and actual results. +In particular, PISA was written by and for the IceCube Collaboration for analyses employing the [IceCube Neutrino Observatory](https://icecube.wisc.edu/), including the [DeepCore](https://arxiv.org/abs/1109.6096) and the planned [Upgrade]([https://arxiv.org/abs/2307.15295](https://arxiv.org/pdf/1908.09441.pdf)) low-energy in-fill arrays. -PISA was originally developed to cope with low-statistics Monte Carlo (MC) for PINGU when iterating on multiple proposed geometries by using parameterizations of the MC and operate on histograms of the data rather than directly reweighting the MC (as is traditionally done in high-energy Physics experiments). -However, PISA's methods apply equally well to high-MC situations, and PISA also performs traditional reweighted-MC analysis as well. +> [!NOTE] +> However, any experiment can make use of PISA for analyzing expected and actual results. -If you use PISA, please cite our publication (e-Print available here: https://arxiv.org/abs/1803.05390): +PISA was originally developed to cope with low-statistics Monte Carlo (MC) by using parameterizations of the MC and operate on histograms of the data rather than directly reweighting the MC. However, PISA's methods apply equally well to high-MC situations, and PISA also performs traditional reweighted-MC analysis as well. + +If you use PISA, please cite our publication ([e-Print available here](https://arxiv.org/abs/1803.05390)): ``` -"Computational Techniques for the Analysis of Small Signals -in High-Statistics Neutrino Oscillation Experiments" -IceCube Collaboration - M.G. Aartsen et al. (Mar 14, 2018) +Computational Techniques for the Analysis of Small Signals +in High-Statistics Neutrino Oscillation Experiments +IceCube Collaboration - M.G. Aartsen et al. +Mar 14, 2018 Published in: Nucl.Instrum.Meth.A 977 (2020) 164332 ``` - # Quick start ## Installation