Entry point to citations management. This object may be used to record Bibtex citation information and then register that a particular citation is relevant for a particular simulation.
Citations listed in pybamm/CITATIONS.txt can be registered with their citation
key. For all other works provide a BibTex Citation to register()
.
Examples
>>> import pybamm
>>> pybamm.citations.register("Sulzer2021")
>>> pybamm.citations.register("@misc{Newton1687, title={Mathematical...}}")
>>> pybamm.print_citations("citations.txt")
Print all citations that were used for running simulations.
filename (str, optional) – Filename to which to print citations. If None, citations are printed to the terminal.
Reads the citations in pybamm.CITATIONS.txt. Other works can be cited
by passing a BibTex citation to register()
.
Register a paper to be cited. The intended use is that register()
should be called only when the referenced functionality is actually being used.
Warning
Registering a BibTex citation, with the same key as an existing citation, will overwrite the current citation.
key (str) –
The citation key for an entry in pybamm/CITATIONS.txt or
One or more BibTex formatted citations