TomWagg / software-citation-station

A website for making citing software used in your research quick and easy
23 stars 2 forks source link

[NEW SUBMISSION] Redback #48

Closed nikhil-sarin closed 1 month ago

nikhil-sarin commented 1 month ago

Logo - https://github.com/nikhil-sarin/redback/blob/master/examples/notebook_images/RedbackLogo.png

Citation information

"Redback": {
    "tags": [
        "sarin_redback"
    ],
    "logo": "img/Redback.png",
    "language": "Python",
    "category": "Transients",
    "keywords": [],
    "description": "A package for simulating, modelling, and inference of all electromagnetic transients and multi-messenger inference.",
    "link": "https://redback.readthedocs.io/en/latest/",
    "attribution_link": "https://redback.readthedocs.io/en/latest/acknowledgements.html#general-citation-text",
    "zenodo_doi": "",
    "custom_citation": "Instructions available at https://redback.readthedocs.io/en/latest/acknowledgements.html#general-citation-text",
    "dependencies": [
        "numpy",
        "scipy"
    ]
}

BibTeX

@ARTICLE{sarin_redback,
       author = {{Sarin}, Nikhil and {H{\"u}bner}, Moritz and {Omand}, Conor M.~B. and {Setzer}, Christian N. and et al.},
        title = "{Redback: A Bayesian inference software package for electromagnetic transients}",
      journal = {arXiv e-prints},
     keywords = {Astrophysics - High Energy Astrophysical Phenomena},
         year = 2023,
        month = aug,
          eid = {arXiv:2308.12806},
        pages = {arXiv:2308.12806},
archivePrefix = {arXiv},
       eprint = {2308.12806},
 primaryClass = {astro-ph.HE},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2023arXiv230812806S},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
TomWagg commented 1 month ago

Thanks @nikhil-sarin - this looks great, cool package! 💥

Have you considered indexing it on Zenodo? It's a fairly simple process (step-by-step guide here) and will create a new record on Zenodo for each version that you release on GitHub. This helps people cite the specific version that they use via a DOI and give proper credit to all contributors. It can also be helpful for accurately keeping track of who cites your package. If you end up doing this please comment the DOI on this issue and I'll add it to the record! ☺️

nikhil-sarin commented 1 month ago

Thanks @TomWagg! I've also done the zenodo indexing.

DOI: 10.5281/zenodo.12735387

Also could you update the bibtex to this, sorry I used the arXiv reference before.

@ARTICLE{sarin24_redback,_
       author = {{Sarin}, Nikhil and {H{\"u}bner}, Moritz and {Omand}, Conor M.~B. and {Setzer}, Christian N. and {Schulze}, Steve and {Adhikari}, Naresh and {Sagu{\'e}s-Carracedo}, Ana and {Galaudage}, Shanika and {Wallace}, Wendy F. and {Lamb}, Gavin P. and {Lin}, En-Tzu},
        title = "{REDBACK: a Bayesian inference software package for electromagnetic transients}",
      journal = {\mnras},
     keywords = {Astrophysics - High Energy Astrophysical Phenomena},
         year = 2024,
        month = jun,
       volume = {531},
       number = {1},
        pages = {1203-1227},
          doi = {10.1093/mnras/stae1238},
archivePrefix = {arXiv},
       eprint = {2308.12806},
 primaryClass = {astro-ph.HE},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2024MNRAS.531.1203S},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
TomWagg commented 1 month ago

Great, I'll update the record now. And don't worry about the BibTeX, I actually already updated that from the arXiv one in the first commit :D