==============
Citation Guide
==============

.. image:: https://zenodo.org/badge/328470267.svg
   :target: https://zenodo.org/badge/latestdoi/328470267

Gravelamps is freely provided under the GPLv3-or-later License. If it has been
helpful to you, please consider citing the code using the above DOI. If
Gravelamps has been helpful specifically in the production of a scientific
publication, a citation of the methodological paper presenting Gravelamps is
provided below:

.. code-block:: bibtex

   @article{gravelamps_methods,
      doi = {10.3847/1538-4357/ac7ec2},
      url = {https://doi.org/10.4837/1538-4357/ac7ec2},
      year = 2022,
      month = {aug},
      publisher = {American Astronomical Society},
      volume = {935},
      number = {2},
      pages = {68},
      author = {Wright, Mick and Hendry, Martin},
      title = {Gravelamps: Gravitational Wave Lensing Mass Profile Model Selection},
      journal = {The Astrophysical Journal},
   }

Further, if the millilensing functionality of Gravelamps was helpful to your
work, we would additionally ask that you cite

.. code-block:: bibtex

  @article{millilensing_methods,
     title = {Exploring the hidden Universe: a novel phenomenological approach
     for recovering arbitrary gravitational-wave millilensing configurations},
     volume = {525},
     ISSN = {1365-2966},
     url = {http://dx.doi.org/10.1093/mnras/stad1302},
     DOI = {10.1093/mnras/stad1302},
     number = {3},
     journal = {Monthly Notices of the Royal Astronomical Society},
     publisher = {Oxford University Press (OUP)},
     author = {Liu, Anna and Wong, Isaac C F and Leong, Samson H W and More,
     Anupreeta and Hannuksela, Otto A and Li, Tjonnie G F},
     year = {2023},
     month = May, 
     pages= {4149–4160}
  }

We would additionally encourage following the citation practices for our
upstream dependencies---in particular those of `bilby`, `bilby_pipe`, `arb`,
and `asimov`.