.. _pydrad-citation:

Citing pydrad
===============

If you make use of pydrad in your work that leads to a publication, it would be
appreciated if you cite the software package.

Please add the following line in your acknowledgements:

*This research used version X.Y.Z (software citation) of the pydrad open source software package.*

The software citation should be the specific `Zenodo DOI`_ for the version used within your work.
The citation for the most current version on Zenodo is

.. code:: bibtex

   @software{Barnes2023,
      author       = {Will Barnes and
                      Jeffrey Reep and
                      Stephen Bradshaw},
      title        = {rice-solar-physics/pydrad: v0.1},
      month        = oct,
      year         = 2023,
      publisher    = {Zenodo},
      version      = {v0.1},
      doi          = {10.5281/zenodo.8411058},
      url          = {https://doi.org/10.5281/zenodo.8411058}
   }

In addition to citing pydrad, you should also cite the HYDRAD code itself.

.. _Zenodo DOI: https://doi.org/10.5281/zenodo.8411057