Riroriro
Riroriro: Simulating gravitational waves and evaluating their detectability in Python - Published in JOSS (2021)
Science Score: 93.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 10 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
A code for simulating gravitational waves and evaluating their detectability.
Basic Info
Statistics
- Stars: 27
- Watchers: 4
- Forks: 4
- Open Issues: 0
- Releases: 1
Topics
Metadata Files
README.md
riroriro
Riroriro is a set of Python modules containing functions to simulate the gravitational waveforms of mergers of black holes and/or neutron stars, and calculate several properties of these mergers and waveforms, specifically relating to their observability by gravitational wave detectors. Riroriro combines areas covered by previous gravitational wave models (such as gravitational wave simulation, SNR calculation, horizon distance calculation) into a single package with broader scope and versatility in Python, a programming language that is ubiquitous in astronomy. Aside from being a research tool, Riroriro is also designed to be easy to use and modify, and it can also be used as an educational tool for students learning about gravitational waves.
The modules “inspiralfuns”, “mergerfirstfuns”, “matchingfuns”, “mergersecondfuns” and “gwexporter”, in that order, can be used to simulate the strain amplitude and frequency of a merger gravitational waveform. The module “snrcalculatorfuns” can compare such a simulated waveform to a detector noise spectrum to calculate a signal-to-noise ratio (SNR) for that signal for that detector. The module “horizondistfuns” calculates the horizon distance of a merger given its waveform, and the module “detectabilityfuns” evaluates the detectability of a merger given its SNR.
Riroriro is installable via pip:
pip install riroriro
More information on the pip installation can be found here: https://pypi.org/project/riroriro/
Tutorials for Riroriro can be found here: https://github.com/wvanzeist/riroriro_tutorials
Full documentation of each of the functions of Riroriro can be found here: https://wvanzeist.github.io/
Riroriro is one of several Python packages associated with BPASS (Binary Population And Spectral Synthesis), a suite of programs that simulates the evolution of a population of binary and single-star systems from a wide range of initial conditions. Each of these associated packages are named after native animals of New Zealand. The riroriro (Gerygone igata, also known as the grey warbler) is a small bird that can be recognised by its distinctive melodious call but is rarely seen, similarly to how black hole binary mergers are detected by their gravitational wave signals rather than visually.
The central website of BPASS, which also contains links to related programs, can be found here: https://bpass.auckland.ac.nz
Paper
A paper describing Riroriro has been published in the Journal of Open Source Software. If you use Riroriro in your work, please cite this paper! https://doi.org/10.21105/joss.02968
@ARTICLE{2021JOSS....6.2968V,
author = {{van Zeist}, Wouter G.~J. and {Stevance}, H{\'e}lo{\"i}se F. and {Eldridge}, J.~J.},
title = "{Riroriro: Simulating gravitational waves and evaluating their detectability in Python}",
journal = {The Journal of Open Source Software},
keywords = {Python, neutron stars, astronomy, gravitational waves, black holes, General Relativity and Quantum Cosmology, Astrophysics - High Energy Astrophysical Phenomena},
year = 2021,
month = mar,
volume = {6},
number = {59},
eid = {2968},
pages = {2968},
doi = {10.21105/joss.02968},
archivePrefix = {arXiv},
eprint = {2103.06943},
primaryClass = {gr-qc},
adsurl = {https://ui.adsabs.harvard.edu/abs/2021JOSS....6.2968V},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
Owner
- Name: Wouter van Zeist
- Login: wvanzeist
- Kind: user
- Repositories: 3
- Profile: https://github.com/wvanzeist
Radboud University/Leiden University Astrophysics
JOSS Publication
Riroriro: Simulating gravitational waves and evaluating their detectability in Python
Authors
Department of Physics, University of Auckland, New Zealand
Department of Physics, University of Auckland, New Zealand
Department of Physics, University of Auckland, New Zealand
Tags
astronomy gravitational waves black holes neutron starsGitHub Events
Total
- Issues event: 2
- Watch event: 1
- Push event: 1
Last Year
- Issues event: 2
- Watch event: 1
- Push event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| wvanzeist | 6****t | 159 |
| wvan478 | w****8@a****z | 1 |
| Dan Foreman-Mackey | f****y@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 6
- Total pull requests: 19
- Average time to close issues: 9 days
- Average time to close pull requests: about 1 hour
- Total issue authors: 4
- Total pull request authors: 2
- Average comments per issue: 1.83
- Average comments per pull request: 0.0
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- katiebreivik (2)
- GregoryAshton (2)
- pllim (1)
- Krytic (1)
Pull Request Authors
- wvanzeist (18)
- dfm (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 19 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 11
- Total maintainers: 1
pypi.org: riroriro
A code for simulating gravitational waves and evaluating their detectability.
- Homepage: https://github.com/wvanzeist/riroriro
- Documentation: https://riroriro.readthedocs.io/
- License: BSD 3-Clause
-
Latest release: 1.0.2
published over 4 years ago
