Citations

class pybamm.Citations

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(filename=None, output_format='text')

Print all citations that were used for running simulations.

Parameters:

filename (str, optional) – Filename to which to print citations. If None, citations are printed to the terminal.

read_citations()

Reads the citations in pybamm.CITATIONS.txt. Other works can be cited by passing a BibTeX citation to register().

register(key)

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.

Parameters:

key (str) –

• The citation key for an entry in pybamm/CITATIONS.txt or

• One or more BibTeX formatted citations

pybamm.print_citations(filename=None, output_format='text')

See Citations.print()