.. _citing:

##################
Acknowledging Yade
##################

We kindly ask YADE users to cite the documentation in scientific publications as a way to assess YADE's contribution to their field.

For the YADE project in general, please reference the documentation as a whole:

- V. Šmilauer et al. (2021), *Yade Documentation* 3rd ed. The Yade Project. `DOI:10.5281/zenodo.5705394 <https://dx.doi.org/10.5281/zenodo.5705394>`_

  .. code-block:: bibtex

      @article{yade2021,
        title        = {Yade Documentation (3rd edition)},
        author       = {Smilauer, Vaclav and Angelidakis, Vasileios and Catalano, Emanuele and Caulk, Robert and Chareyre, Bruno and Ch{\ifmmode\grave{e}\else\`{e}\fi}vremont, William and Dorofeenko, Sergei and Duriez, J{\ifmmode\acute{e}\else\'{e}\fi}r{\ifmmode\hat{o}\else\^{o}\fi}me and Dyck, Nolan and Elias, Jan and Er, Burak and Eulitz, Alexander and Gladky, Anton and Guo, Ning and Jakob, Christian and Kneib, Francois and Kozicki, Janek and Marzougui, Donia and Maurin, Raphael and Modenese, Chiara and Pekmezi, Gerald and Scholt{\ifmmode\grave{e}\else\`{e}\fi}s, Luc and Sibille, Luc and Stransky, Jan and Sweijen, Thomas and Thoeni, Klaus and Yuan, Chao},
        year         = {2021},
        journal      = {Zenodo},
        doi          = {10.5281/zenodo.5705394}
      }

For newer features of YADE, please reference the review article:

- V. Angelidakis et al. "YADE - An extensible framework for the interactive simulation of multiscale, multiphase, and multiphysics particulate systems", *Computer Physics Communications* 304 (2024): 109293. `DOI:10.1016/j.cpc.2024.109293 <https://doi.org/10.1016/j.cpc.2024.109293>`_

  .. code-block:: bibtex

      @article{yade2024,
        author  = {Angelidakis, Vasileios and Boschi, Katia and Brzezi{\ifmmode\acute{n}\else\'{n}\fi}ski, Karol and Caulk, Robert A. and Chareyre, Bruno and del Valle, Carlos Andr{\ifmmode\acute{e}\else\'{e}\fi}s and Duriez, J{\ifmmode\acute{e}\else\'{e}\fi}r{\ifmmode\hat{o}\else\^{o}\fi}me and Gladky, Anton and van der Haven, Dingeman L. H. and Kozicki, Janek and Pekmezi, Gerald and Scholt{\ifmmode\grave{e}\else\`{e}\fi}s, Luc and Thoeni, Klaus},
        title   = {{YADE - An extensible framework for the interactive simulation of multiscale, multiphase, and multiphysics particulate systems}},
        journal = {Computer Physics Communications},
        volume  = {304},
        pages   = {109293},
        year    = {2024},
        month   = nov,
        issn    = {0010-4655},
        publisher = {North-Holland},
        doi     = {10.1016/j.cpc.2024.109293},
        url     = {https://doi.org/10.1016/j.cpc.2024.109293}
      }

Ideally, users cite both documents to acknowledge the work of both earlier and later developers of YADE. Beyond acknowledgment, proper referencing helps find new use cases and new users by tracking the citations on `Yade's Scholar profile <https://scholar.google.com/citations?user=hZB8GGcAAAAJ&hl=en>`_.
