{"id":24464760,"url":"https://github.com/meighenbergers/fennel","last_synced_at":"2025-08-28T22:27:06.572Z","repository":{"id":57429078,"uuid":"424254926","full_name":"MeighenBergerS/fennel","owner":"MeighenBergerS","description":"Light-yield calculation for cascades and tracks.","archived":false,"fork":false,"pushed_at":"2022-10-11T23:45:33.000Z","size":5697,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-24T06:04:23.160Z","etag":null,"topics":["cascades","cherenkov-radiation","light","neutrino","tracks"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MeighenBergerS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-03T14:23:17.000Z","updated_at":"2023-08-31T03:04:25.000Z","dependencies_parsed_at":"2022-09-08T23:40:47.066Z","dependency_job_id":null,"html_url":"https://github.com/MeighenBergerS/fennel","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeighenBergerS%2Ffennel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeighenBergerS%2Ffennel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeighenBergerS%2Ffennel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeighenBergerS%2Ffennel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MeighenBergerS","download_url":"https://codeload.github.com/MeighenBergerS/fennel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243565329,"owners_count":20311705,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cascades","cherenkov-radiation","light","neutrino","tracks"],"created_at":"2025-01-21T05:16:48.095Z","updated_at":"2025-03-14T11:21:04.914Z","avatar_url":"https://github.com/MeighenBergerS.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fennel\n\nAuthors:\n\n1. Stephan Meighen-Berger, developed the Fennel Code\n\n## Table of contents\n\n1. [Introduction](#introduction)\n\n2. [Citation](#citation)\n\n3. [Documentation](#documentation)\n\n4. [Installation](#installation)\n\n5. [Beta](#beta)\n\n## Introduction \u003ca name=\"introduction\"\u003e\u003c/a\u003e\n\nWelcome to Fennel!\n\n![Logo](images/Fennel.png)\n\nA python package to simulate the light production of particles.\nIt calculates the light emissions from cascades and tracks.\n\n## Citation \u003ca name=\"citation\"\u003e\u003c/a\u003e\n\nThis packages includes/uses distributions developed in\n\nLeif Rädel, Christopher Wiebusch,\\\n*Calculation of the Cherenkov light yield from low energetic secondary particles accompanying high-energy muons in ice and water with Geant4 simulations*,\\\nAstroparticle Physics,\nVolume 38,\n2012,\nPages 53-67,\nISSN 0927-6505,\\\n\u003chttps://doi.org/10.1016/j.astropartphys.2012.09.008.\u003e\n(\u003chttps://www.sciencedirect.com/science/article/pii/S0927650512001831\u003e)\n\nand\n\n\u003chttps://www.institut3b.physik.rwth-aachen.de/global/show_document.asp?id=aaaaaaaaaapwhjz\u003e\n\nPlease cite this [software](https://github.com/MeighenBergerS/fennel) using\n\n```\n@software{fennel2022@github,\n  author = {Stephan Meighen-Berger},\n  title = {{Fennel}: Light from tracks and cascades,\n  url = {https://github.com/MeighenBergerS/fennel},\n  version = {1.3.4},\n  year = {2022},\n}\n```\n\nand their work when using this package.\n\n## Documentation \u003ca name=\"documentation\"\u003e\u003c/a\u003e\n\nThe package provides automatically generated documentation under\n\u003chttps://meighenbergers.github.io/fennel/\u003e\n\n## Installation \u003ca name=\"installation\"\u003e\u003c/a\u003e\n\nInstall using pip:\n\n```python\npip install fennel_seed\n```\n\n[The PyPi webpage](https://pypi.org/project/fennel-seed/)\n\nOther installation methods:\nTo install please clone the [repository](https://github.com/MeighenBergerS/fennel) or download the latest release. Then\nfollow the instructions given in INSTALL.txt.\nNote this should install all necessary components.\n\nOr install using the setup.py\n\nPlease note that JAX is not included in the basic installation.\nTo use this option, please also install JAX or install fennel using:\n\n```python\npip install fennel_seed[jax]\n```\n\nFor the cpu version of jax use:\n\n```python\npip install fennel_seed[cpu]\n```\n\nTo be able to run the example notebook use:\n\n```python\npip install fennel_seed[interactive]\n```\n\n## Beta \u003ca name=\"beta\"\u003e\u003c/a\u003e\n\nFennel offers a few subprojects which are currently still in beta. While these projects work, they have as of yet not been designed for usability. Currently available subprojects are available offer the GitHub repository (not pip!). Subprojects are:\n\n1. Jfennel: A Julia implementation of Fennel. This is its own branch in the repository and still requires further work and cross-checks.\n\n2. Seed: An interface to the Geant4 code used for the parametrization. The code itself offers a Python interface for ease of use. To use this code, a Geant4 installation is required. Currently this module has only been tested in a Linux environment. The code itself is contained in the seed folder and includes some examples in the notebooks folder on how to use it. Please note the codes there work for Geant4 version 1.10. Version 1.11 breaks compability with of some of the provided codes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeighenbergers%2Ffennel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeighenbergers%2Ffennel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeighenbergers%2Ffennel/lists"}