Skip to content

Commit

Permalink
Merge pull request #12 from plaplant/joss_submission
Browse files Browse the repository at this point in the history
Small changes to JOSS submission paper
  • Loading branch information
a-renzini authored Feb 14, 2024
2 parents 777445c + 40aa84e commit 5dbe3e7
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 32 deletions.
54 changes: 23 additions & 31 deletions JOSS_submission/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ @article{Collaboration2022TheAP
year={2022},
volume={935}
}
@Article{ harris2020array,
@Article{harris2020array,
title = {Array programming with {NumPy}},
author = {Charles R. Harris and K. Jarrod Millman and St{\'{e}}fan J.
van der Walt and Ralf Gommers and Pauli Virtanen and David
Expand Down Expand Up @@ -141,25 +141,6 @@ @article{Abbott_2021
journal = {Physical Review D}
}
@ARTICLE{astropy,
author = {{Astropy Collaboration} and {Price-Whelan}, Adrian M. and {Lim}, Pey Lian and {Earl}, Nicholas and {Starkman}, Nathaniel and {Bradley}, Larry and {Shupe}, David L. and {Patil}, Aarya A. and {Corrales}, Lia and {Brasseur}, C.~E. and {N{\"o}the}, Maximilian and {Donath}, Axel and {Tollerud}, Erik and {Morris}, Brett M. and {Ginsburg}, Adam and {Vaher}, Eero and {Weaver}, Benjamin A. and {Tocknell}, James and {Jamieson}, William and {van Kerkwijk}, Marten H. and {Robitaille}, Thomas P. and {Merry}, Bruce and {Bachetti}, Matteo and {G{\"u}nther}, H. Moritz and {Aldcroft}, Thomas L. and {Alvarado-Montes}, Jaime A. and {Archibald}, Anne M. and {B{\'o}di}, Attila and {Bapat}, Shreyas and {Barentsen}, Geert and {Baz{\'a}n}, Juanjo and {Biswas}, Manish and {Boquien}, M{\'e}d{\'e}ric and {Burke}, D.~J. and {Cara}, Daria and {Cara}, Mihai and {Conroy}, Kyle E. and {Conseil}, Simon and {Craig}, Matthew W. and {Cross}, Robert M. and {Cruz}, Kelle L. and {D'Eugenio}, Francesco and {Dencheva}, Nadia and {Devillepoix}, Hadrien A.~R. and {Dietrich}, J{\"o}rg P. and {Eigenbrot}, Arthur Davis and {Erben}, Thomas and {Ferreira}, Leonardo and {Foreman-Mackey}, Daniel and {Fox}, Ryan and {Freij}, Nabil and {Garg}, Suyog and {Geda}, Robel and {Glattly}, Lauren and {Gondhalekar}, Yash and {Gordon}, Karl D. and {Grant}, David and {Greenfield}, Perry and {Groener}, Austen M. and {Guest}, Steve and {Gurovich}, Sebastian and {Handberg}, Rasmus and {Hart}, Akeem and {Hatfield-Dodds}, Zac and {Homeier}, Derek and {Hosseinzadeh}, Griffin and {Jenness}, Tim and {Jones}, Craig K. and {Joseph}, Prajwel and {Kalmbach}, J. Bryce and {Karamehmetoglu}, Emir and {Ka{\l}uszy{\'n}ski}, Miko{\l}aj and {Kelley}, Michael S.~P. and {Kern}, Nicholas and {Kerzendorf}, Wolfgang E. and {Koch}, Eric W. and {Kulumani}, Shankar and {Lee}, Antony and {Ly}, Chun and {Ma}, Zhiyuan and {MacBride}, Conor and {Maljaars}, Jakob M. and {Muna}, Demitri and {Murphy}, N.~A. and {Norman}, Henrik and {O'Steen}, Richard and {Oman}, Kyle A. and {Pacifici}, Camilla and {Pascual}, Sergio and {Pascual-Granado}, J. and {Patil}, Rohit R. and {Perren}, Gabriel I. and {Pickering}, Timothy E. and {Rastogi}, Tanuj and {Roulston}, Benjamin R. and {Ryan}, Daniel F. and {Rykoff}, Eli S. and {Sabater}, Jose and {Sakurikar}, Parikshit and {Salgado}, Jes{\'u}s and {Sanghi}, Aniket and {Saunders}, Nicholas and {Savchenko}, Volodymyr and {Schwardt}, Ludwig and {Seifert-Eckert}, Michael and {Shih}, Albert Y. and {Jain}, Anany Shrey and {Shukla}, Gyanendra and {Sick}, Jonathan and {Simpson}, Chris and {Singanamalla}, Sudheesh and {Singer}, Leo P. and {Singhal}, Jaladh and {Sinha}, Manodeep and {Sip{\H{o}}cz}, Brigitta M. and {Spitler}, Lee R. and {Stansby}, David and {Streicher}, Ole and {{\v{S}}umak}, Jani and {Swinbank}, John D. and {Taranu}, Dan S. and {Tewary}, Nikita and {Tremblay}, Grant R. and {de Val-Borro}, Miguel and {Van Kooten}, Samuel J. and {Vasovi{\'c}}, Zlatan and {Verma}, Shresth and {de Miranda Cardoso}, Jos{\'e} Vin{\'\i}cius and {Williams}, Peter K.~G. and {Wilson}, Tom J. and {Winkel}, Benjamin and {Wood-Vasey}, W.~M. and {Xue}, Rui and {Yoachim}, Peter and {Zhang}, Chen and {Zonca}, Andrea and {Astropy Project Contributors}},
title = "{The Astropy Project: Sustaining and Growing a Community-oriented Open-source Project and the Latest Major Release (v5.0) of the Core Package}",
journal = {\apj},
keywords = {Astronomy software, Open source software, Astronomy data analysis, 1855, 1866, 1858, Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2022,
month = aug,
volume = {935},
number = {2},
eid = {167},
pages = {167},
doi = {10.3847/1538-4357/ac7c74},
archivePrefix = {arXiv},
eprint = {2206.14220},
primaryClass = {astro-ph.IM},
adsurl = {https://ui.adsabs.harvard.edu/abs/2022ApJ...935..167A},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@article{Planck2018,
author = "Aghanim, N. and others",
collaboration = "Planck",
Expand All @@ -168,7 +149,7 @@ @article{Planck2018
archivePrefix = "arXiv",
primaryClass = "astro-ph.CO",
doi = "10.1051/0004-6361/201833910",
journal = "Astron. Astrophys.",
journal = "Astronomy and Astrophysics",
volume = "641",
pages = "A6",
year = "2020",
Expand Down Expand Up @@ -208,23 +189,34 @@ @article{AllenRomano
archivePrefix = "arXiv",
reportNumber = "WISC-MILW-97-TH-14",
doi = "10.1103/PhysRevD.59.102001",
journal = "Phys. Rev. D",
journal = "Physical Review D",
volume = "59",
pages = "102001",
year = "1999"
}
@article{pygwb_paper,
author = "Renzini, Arianna I. and others",
title = "{pygwb: Python-based library for gravitational-wave background searches}",
eprint = "2303.15696",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
month = "3",
year = "2023"
@ARTICLE{pygwb_paper,
author = {{Renzini}, Arianna I. and {Romero-Rodr{\'\i}guez}, Alba and {Talbot}, Colm and {Lalleman}, Max and {Kandhasamy}, Shivaraj and {Turbang}, Kevin and {Biscoveanu}, Sylvia and {Martinovic}, Katarina and {Meyers}, Patrick and {Tsukada}, Leo and {Janssens}, Kamiel and {Davis}, Derek and {Matas}, Andrew and {Charlton}, Philip and {Liu}, Guo-Chin and {Dvorkin}, Irina and {Banagiri}, Sharan and {Bose}, Sukanta and {Callister}, Thomas and {De Lillo}, Federico and {D'Onofrio}, Luca and {Garufi}, Fabio and {Harry}, Gregg and {Lawrence}, Jessica and {Mandic}, Vuk and {Macquet}, Adrian and {Michaloliakos}, Ioannis and {Mitra}, Sanjit and {Pham}, Kiet and {Poggiani}, Rosa and {Regimbau}, Tania and {Romano}, Joseph D. and {van Remortel}, Nick and {Zhong}, Haowen},
title = "{pygwb: A Python-based Library for Gravitational-wave Background Searches}",
journal = {The Astrophysical Journal},
keywords = {Gravitational wave astronomy, Gravitational waves, Gravitational wave detectors, 675, 678, 676, General Relativity and Quantum Cosmology, Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2023,
month = jul,
volume = {952},
number = {1},
eid = {25},
pages = {25},
doi = {10.3847/1538-4357/acd775},
archivePrefix = {arXiv},
eprint = {2303.15696},
primaryClass = {gr-qc},
adsurl = {https://ui.adsabs.harvard.edu/abs/2023ApJ...952...25R},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@article{stochasticm,
author = "LVK",
title = "{stochastic.m}",
url = "{ https://git.ligo.org/stochastic-public/stochastic}",
url = {https://git.ligo.org/stochastic-public/stochastic},
year = "{2020}"
}
2 changes: 1 addition & 1 deletion JOSS_submission/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ where $\Omega_{\rm M}(f|\lambda)$ is the GWB model and $\lambda$ are its paramet

The `pygwb` package is class-based and modular to facilitate the evolution of the code and to increase flexibility of the analysis pipeline. The advantage of the Python language lies in rapid code execution, while maintaining a certain level of user-friendliness, which results in a shallow learning curve and will encourage future contributions to the code from the whole GW community. A summary of all `pygwb` modules and its main external dependencies can be found in the `pygwb` schema \autoref{fig:schema}.

The package is compatible with GW frame files in a variety of formats, relying on the I/O functionality of `gwpy` [@gwpy]. `NumPy` [@harris2020array] is heavily used within the `pygwb` code, as well as `matplotlib` [@Hunter:2007] for plotting purposes. Some of the frequency-related computations rely on functionalities of the `scipy` [@2020SciPy-NMeth] package. The `astropy` [@astropy] package is employed for cosmology-related computations. The parameter estimation module included in `pygwb` is based on `Bilby` [@Ashton_2019] and the `dynesty` [@Speagle_2020] sampler package.
The package is compatible with GW frame files in a variety of formats, relying on the I/O functionality of `gwpy` [@gwpy]. `NumPy` [@harris2020array] is heavily used within the `pygwb` code, as well as `matplotlib` [@Hunter:2007] for plotting purposes. Some of the frequency-related computations rely on functionalities of the `scipy` [@2020SciPy-NMeth] package. The `astropy` [@Collaboration2022TheAP] package is employed for cosmology-related computations. The parameter estimation module included in `pygwb` is based on `Bilby` [@Ashton_2019] and the `dynesty` [@Speagle_2020] sampler package.

A customizable pipeline script, `pygwb_pipe`, is provided with the package and can be run in default mode, which reproduces the methodology of the LVK isotropic analysis implemented on the most recent observation run [@Abbott_2021]. On the other hand, the modularity of the package allows users to develop custom `pygwb` pipelines to fit their needs.
A set of simple statistical checks can be performed on the data after a `pygwb` run by using the `statistical_checks` module.
Expand Down
Binary file modified JOSS_submission/paper.pdf
Binary file not shown.

0 comments on commit 5dbe3e7

Please sign in to comment.