=====================
How to cite **freud**
=====================

Please acknowledge the use of this software within the body of your publication for example by copying or adapting the following formulation:

*Data analysis for this publication utilized the freud library[1].*

  [1] V. Ramasubramani, B. D. Dice, E. S. Harper, M. P. Spellings, J. A. Anderson, and S. C. Glotzer. freud: A Software Suite for High Throughput Analysis of Particle Simulation Data. Computer Physics Communications Volume 254, September 2020, 107275. doi:10.1016/j.cpc.2020.107275.

The paper is available online from `Computer Physics Communications <https://www.sciencedirect.com/science/article/pii/S0010465520300916>`_ and a pre-print is freely available on `arXiv <https://arxiv.org/abs/1906.06317>`_.

To cite this reference, you can use the following BibTeX entry:

.. code-block:: bibtex

    @article{freud2020,
        title = {freud: A Software Suite for High Throughput
                 Analysis of Particle Simulation Data},
        author = {Vyas Ramasubramani and
                  Bradley D. Dice and
                  Eric S. Harper and
                  Matthew P. Spellings and
                  Joshua A. Anderson and
                  Sharon C. Glotzer},
        journal = {Computer Physics Communications},
        volume = {254},
        pages = {107275},
        year = {2020},
        issn = {0010-4655},
        doi = {https://doi.org/10.1016/j.cpc.2020.107275},
        url = {http://www.sciencedirect.com/science/article/pii/S0010465520300916},
        keywords = {Simulation analysis, Molecular dynamics,
                    Monte Carlo, Computational materials science},
    }

Optionally, publications using **freud** in the context of machine learning or data visualization may also wish to cite this reference.

  [2] B. D. Dice, V. Ramasubramani, E. S. Harper, M. P. Spellings, J. A. Anderson, and S. C. Glotzer. Analyzing Particle Systems for Machine Learning and Data Visualization with freud. Proceedings of the 18th Python in Science Conference, 2019, 27-33. doi:10.25080/Majora-7ddc1dd1-004.

The paper is freely available from the `SciPy Conference website <http://conference.scipy.org/proceedings/scipy2019/bradley_dice.html>`_.

To cite this reference, you can use the following BibTeX entry:

.. code-block:: bibtex

    @InProceedings{freud2019,
        title = {Analyzing Particle Systems for Machine Learning
                 and Data Visualization with freud},
        author = {Bradley D. Dice and
                  Vyas Ramasubramani and
                  Eric S. Harper and
                  Matthew P. Spellings and
                  Joshua A. Anderson and
                  Sharon C. Glotzer },
        booktitle = {Proceedings of the 18th Python in Science Conference},
        pages = {27-33},
        year = {2019},
        editor = {Chris Calloway and David Lippa and Dillon Niederhut and David Shupe},
        doi = {https://doi.org/10.25080/Majora-7ddc1dd1-004},
        url = {http://conference.scipy.org/proceedings/scipy2019/bradley_dice.html}
    }