hoomd.cite

Overview

hoomd.cite.save Saves the automatically generated bibliography to a BibTeX file

Details

Commands to support automatic citation generation.

Certain features of HOOMD-blue should be cited because they represent significant contributions from developers. In order to make these citations transparent and easy, HOOMD-blue will automatically print citation notices at run time when you use a feature that should be cited. Users should read and cite these publications in their work. Citations can be saved as a BibTeX file for easy incorporation into bibliographies.

hoomd.cite.save(file=’hoomd.bib’)

Saves the automatically generated bibliography to a BibTeX file

Parameters:file (str) – File name for the saved bibliography

After save() is called for the first time, the bibliography will (re-)generate each time that a new feature is added to ensure that all citations have been included. If file already exists, it will be overwritten.

Examples:

cite.save()
cite.save(file='cite.bib')