pybamm.
Citations
[source]¶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("sulzer2020python")
>>> pybamm.print_citations("citations.txt")
print
(filename=None)[source]¶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. |
---|
register
(key)[source]¶Register a paper to be cited. The intended use is that register()
should be called only when the referenced functionality is actually being used.
Parameters: | key (str) – The key for the paper to be cited |
---|