Skip to content

MeighenBergerS/fennel

Repository files navigation

Fennel

Authors:

  1. Stephan Meighen-Berger, developed the Fennel Code

Table of contents

  1. Introduction

  2. Citation

  3. Documentation

  4. Installation

Introduction

Welcome to Fennel!

Logo

A python package to simulate the light production of particles. It calculates the light emissions from cascades and tracks.

Citation

This packages includes/uses distributions developed in

Leif Rädel, Christopher Wiebusch,
Calculation of the Cherenkov light yield from low energetic secondary particles accompanying high-energy muons in ice and water with Geant4 simulations,
Astroparticle Physics, Volume 38, 2012, Pages 53-67, ISSN 0927-6505,
https://doi.org/10.1016/j.astropartphys.2012.09.008. (https://www.sciencedirect.com/science/article/pii/S0927650512001831)

and

https://www.institut3b.physik.rwth-aachen.de/global/show_document.asp?id=aaaaaaaaaapwhjz

Please cite this page and their work when using this package.

Documentation

The package provides automatically generated documentation under https://meighenbergers.github.io/fennel/

Installation

To install please clone the repository or download the latest release. Then follow the instructions given in INSTALL.txt. Note this should install all necessary components.

Or install using the setup.py