FIRESONG
FIRESONG: A python package to simulate populations of extragalactic neutrino sources - Published in JOSS (2021)
Science Score: 98.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
35 of 42 committers (83.3%) from academic institutions -
✓Institutional organization owner
Organization icecube has institutional domain (icecube.wisc.edu) -
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
FIRst Extragalactic Simulation Of Neutrino and Gamma-ray
Basic Info
Statistics
- Stars: 18
- Watchers: 4
- Forks: 8
- Open Issues: 9
- Releases: 11
Metadata Files
README.md
Firesong
FIRst Extragalactic Simulation Of Neutrinos and Gamma-rays.
Documentation for the astrophysics and cosmology of neutrino sources can be found on: - René Rieman's PhD thesis, section 10. - Theo Glauch's Master thesis, chapter 6. - Chun Fai Tung's PhD thesis, chapter 4.
Set up
This package is developed for Python 3, and can be installed via pip:
pip install firesong
Or by downloading the repository and running:
python setup.py install
If you want to execute scripts of FIRESONG directly via shell command, you can specify where you would like the output of simulations to go, by default. In bash: export FIRESONG=/location/of/FIRESONG/.
Basic usage
Several scripts are provided:
* firesong/Firesong.py - Generates an instance of all neutrino sources in
the Universe according to the parameters provided (e.g. local
neutrino source density). Both the flux and the redshift of neutrino
sources are calculated.
* firesong/FluxPDF.py - Generates the flux probability density distribution of a
source. It complements Firesong.py because is it much faster for large
source densities. Only the flux of neutrino sources is calculated.
* firesong/Legend.py - Generates an instance of gamma-ray sources in the universe
according to a luminosity dependent density evolution (LDDE). Both the
redshift and the gamma-ray flux (without attenuation) are calculated.
Examples:
- A muon neutrino diffuse flux saturation example:
If installed via pip, in in the python console,
from firesong.Firesong import firesong_simulation
firesong_simulation('./', density=1e-6, Evolution='CC2015SNR', zmax=4.0,
fluxnorm=1.44e-8, index=2.28, LF='SC')
or with the repository downloaded
python Firesong.py -d 1e-6 --evolution CC2015SNR --zmax 4.0
--fluxnorm 1.44e-8 --index 2.28 --LF SC
wlll simulate neutrino sources with a local density of 10^-6 Mpc^-3
with a source density evolution that follows the Clash and Candels 2015
Supernova Rate (CC2015SNR). The simulation will be done up to a
redshift of 4.0. The neutrino luminosity, because it is not specified
as an option, will be calculated internally to saturate a muon neutrino diffuse
flux with a normalization, at 100 TeV, of E^2d\phi/dE = 1.44 x 10^-8
GeV.cm^-2.s^-1.sr^-1 and with a spectral index of -2.28. Neutrino
luminosity is distributed as a delta function, i.e., standard candle
(SC). The result will be output as a text file firesong.out in the current
directoy, or in the directory of environment variable FIRESONG if it is set.
- An exploration of the luminosity vs. local density plane (aka
Kowalski plot) example:
in the console
firesong_simulation('./', density=1e-6, Evolution='MD2016SFR', zmax=8.0, index=2.28, LF='SC', luminosity=1e51)or
python Firesong.py -d 1e-6 --evolution MD2016SFR --zmax 8.0
--index 2.28 --LF SC -L 1e51
will simulate neutrino sources with a local density of 10^-6 Mpc^-3 with a source density evolution that follows the Madau and Dickinson 2016 Star Formation Rate History (MD2014SFR). The simulation will be done up to a redshift of 8.0. The neutrino power law spectral index is -2.28. Neutrino luminosity is distributed as a delta function, i.e., standard candle (SC) and is set to be 10^51 erg/year. Note that muon neutrino diffuse flux normalization is ignored when a luminosity is specified, but the spectral index should still be provided. This mode of operation allows the exploration of the luminosity vs. local density plane (aka Kowalski plot).
More examples are included in the notebooks directory.
Jupyter notebook and matplotlib are required to run the examples.
Tests
All unittest could be run by
python -m unittest discover tests/
If you would like to suppress the printed output, you may add a -b flag to this command. If you want to run a test for a certain file separately use either
python -m unittest tests/test_<...>
or
python tests/test_<...>.py
How to request support
Questions about support for FIRESONG can be sent to one of the development leads for FIRESONG. See AUTHORS.md
How to contribute
Community contributions to Firesong are accepted and welcome. Issues can be reported by any user, even if not a member of IceCube. Pull requests can be requested by any user, even if not a member of IceCube.
Owner
- Name: IceCube Neutrino Observatory
- Login: icecube
- Kind: organization
- Location: South Pole Station, Antarctica
- Website: https://icecube.wisc.edu
- Repositories: 52
- Profile: https://github.com/icecube
Repo Guide: https://github.com/icecube/icecube.github.io/wiki
JOSS Publication
FIRESONG: A python package to simulate populations of extragalactic neutrino sources
Authors
School of Physics. Georgia Institute of Technology. Atlanta, GA 30332, USA
Technische Universität München, Physik-Department, James-Frank-Str. 1, D-85748 Garching bei München, Germany
Dept. of Physics, University of Maryland, College Park, MD 20742, USA
Dept. of Physics and Wisconsin IceCube Particle Astrophysics Center, University of Wisconsin–Madison, Madison, WI 53706, USA
Johannes Gutenberg University Mainz, Institute of Physics - QUANTUM, 55128 Mainz, Germany
School of Physics. Georgia Institute of Technology. Atlanta, GA 30332, USA
Editor
Eloisa Bentivegna
Tags
Neutrinos Neutrino Sources Cosmic Rays Multi Messenger Astrophysics CosmologyGitHub Events
Total
Last Year
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Ignacio Taboada | i****a@g****u | 132 |
| René Reimann | r****n@g****m | 76 |
| Alex Pizzuto | p****o@w****u | 48 |
| ChrisCFTung | c****6@g****m | 39 |
| Chun Fai Tung | C****s@C****l | 7 |
| Massimiliano Lincetto | m****o@g****m | 7 |
| Michael Larson | m****n@i****u | 7 |
| Chun Fai Tung | C****s@s****e | 5 |
| Chun Fai Tung | C****s@l****u | 5 |
| Chun Fai Tung | C****s@l****u | 5 |
| Konstancja Satalecka | k****a@d****e | 4 |
| Chun Fai Tung | C****s@l****u | 4 |
| Chun Fai Tung | C****s@l****u | 4 |
| Chun Fai Tung | C****s@l****u | 4 |
| Jost Migenda | j****a@k****k | 3 |
| Chun Fai Tung | C****s@l****u | 3 |
| Chun Fai Tung | C****s@l****u | 3 |
| Chun Fai Tung | C****s@l****u | 3 |
| Alison Peisker | p****a@m****u | 2 |
| TGarfield17 | 5****7 | 2 |
| Theo Glauch | t****h@t****e | 2 |
| Chun Fai Tung | C****s@l****u | 2 |
| Chun Fai Tung | C****s@l****u | 2 |
| Chun Fai Tung | C****s@l****u | 2 |
| Chun Fai Tung | C****s@l****u | 2 |
| Daniel S. Katz | d****z@i****g | 1 |
| Rene Reimann | r****n@u****e | 1 |
| René Reimann | r****n@r****e | 1 |
| Chun Fai Tung | C****s@l****u | 1 |
| Chun Fai Tung | C****s@l****u | 1 |
| and 12 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 32
- Total pull requests: 50
- Average time to close issues: 2 months
- Average time to close pull requests: 8 days
- Total issue authors: 8
- Total pull request authors: 13
- Average comments per issue: 1.31
- Average comments per pull request: 0.12
- Merged pull requests: 40
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- itaboada (12)
- apizzuto (7)
- JostMigenda (5)
- mjlarson (2)
- tglauch (2)
- HansN87 (2)
- mlincett (1)
- renereimann (1)
Pull Request Authors
- ChrisCFTung (16)
- apizzuto (11)
- renereimann (6)
- JostMigenda (3)
- mjlarson (3)
- tglauch (2)
- dependabot[bot] (2)
- Konstancja (2)
- alisonpeisker (1)
- itaboada (1)
- TGarfield17 (1)
- mlincett (1)
- danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 12 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 4
- Total maintainers: 2
pypi.org: firesong
Code for simulationg populations of neutrino sources
- Homepage: https://github.com/icecube/FIRESONG
- Documentation: https://firesong.readthedocs.io/
- License: BSD License
-
Latest release: 1.6.1
published almost 5 years ago
Rankings
Maintainers (2)
Dependencies
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- coverage ==5.4
- numpy ==1.22.0
- scipy ==1.6
- CosmoloPy >=0.4
- coverage >=5.4
- numpy >=1.22.0
- scipy >=1.2.3