Acknowledgements
The paper describing redback
is submitted and available here.
If you use redback
in a scientific publication please cite this paper and mention it as a software used depending on the journal.
Some specific instances/examples of acknowledgements are given below.
The main repository includes a bibtex citation for the redback
paper.
Using redback
to fit transients
If you use redback
to fit an electromagnetic transient,
please cite the Bilby paper,
and the redback
paper.
Alongside this we request that you also cite the paper associated with the sampler you use.
Furthermore, several models implemented in redback
are introduced in previous scientific publications.
These scientific publications are easily accessible via model_name.citation
or as a reference in a class.
For example,
from redback.transient_models import kilonova_models
import numpy as np
citation = kilonova_models.one_component_kilonova_model.citation
Here citation will be a url or a series of urls to the NASA ads page for the paper describing the model. If you use a specific model or build upon it, we request that you also cite the paper for the model.
In several cases, the citation will be redback, in which case,
only a citation to redback
, bilby
, and the sampler is necessary.
Although we recommend periodically checking the citation in the latest redback
release.
For optical transients (if you fit in magnitudes/flux), we request that you also cite SNCosmo as that is used to convert redback spectra to magnitudes and integrated bandpass flux.
Using redback
to simulate transients
If you use the capability of redback
to simulate a population of transients,
please cite the redback
paper and the paper for the model you use.
Using redback
to download transient data
If you use redback
to simply download and process data for different transients,
please cite the redback
paper.
General citation text
We recommend the following text for citing redback
in a scientific publication:
For using redback
to fit transients:
We fit the transient using the open source software package {sc Redback}~cite{sarin_redback}, with the {model_name}~citep{model reference} model using the {sampler} sampler~citep{sampler reference} wrapped with bilby~citep{Ashton+2019}.
For using redback
to simulate transients:
We simulate transients using the open source software package {sc Redback}~cite{sarin_redback}, with the {model_name}~citep{model reference} model.
For using redback
to download transient data:
We download and process this data using the API provided for {name of data source}~citep{citation to the source} by the open source software package {sc Redback}~cite{sarin_redback}.