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. For a list of all possible citations, see pybamm/CITATIONS.txt
Examples
>>> import pybamm
>>> pybamm.citations.register("Sulzer2021")
>>> 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.
Register a paper to be cited. The intended use is that register()
should be called only when the referenced functionality is actually being used.
key (str) – The key for the paper to be cited