Light-yields for tracks, and cascades
Project description
Fennel
Authors:
- Stephan Meighen-Berger, developed the Fennel Code
Table of contents
Introduction
Welcome to Fennel!
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 software using
@software{fennel2021@github,
author = {Stephan Meighen-Berger},
title = {{Fennel}: Light from tracks and cascades,
url = {https://github.com/MeighenBergerS/fennel},
version = {1.1.1},
year = {2021},
}
and their work when using this package.
Documentation
The package provides automatically generated documentation under https://meighenbergers.github.io/fennel/
Installation
Install using pip:
pip install fennel_seed
Other installation methods: To install please clone the (repository)[https://github.com/MeighenBergerS/fennel] 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
Please note that JAX is not included in the basic installation. To use this option, please also install JAX or install fennel using: Install using pip:
pip install fennel_seed[jax]
To be able to run the example notebook use Install using pip:
pip install fennel_seed[interactive]
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fennel_seed-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d76efc83711234e8a934ebcfafc401097f75a92d9e20819088c57bbf85dcd8c1 |
|
MD5 | e760ae4325ec996f83ef42b58e6dff91 |
|
BLAKE2b-256 | e6efefe2dbaf610493afbb0bf41de1655d03812f65c14daa20088a4ced1024a0 |