Enforce print_citations() in notebooks

[valentinsulzer]

All notebooks should have the cell pybamm.print_citations() at the end, to encourage people to use this command.
This can be enforced using regex when running the example tests.

[brosaplanella]

I agree. I would also suggest then to print citations in a more friendly format (probably a LaTeX format won't be possible) but at least some sort of plain text reference list. This links to issue #1182.

[rtimms]

pybtex seems to work ok now

e.g.

import pybamm
import pybtex

model = pybamm.lithium_ion.SPM()

sim = pybamm.Simulation(model)
sim.solve([0, 3600])
pybamm.print_citations(filename="test.bib")
print(pybtex.format_from_file("test.bib", "unsrt", output_backend="plaintext"))

you can output to markdown too and pick different styles

[brosaplanella]

That is really cool! Is there a way of doing it without generating a bibtex file every time?

[rtimms]

You can point to a particular file and then pick some keys to cite

print(pybtex.format_from_file("test.bib", "unsrt", citations=["sulzer2020python", "harris2020array"], output_backend="plaintext"))   

In theory we should just be able to point to our CITATIONS.txt and pass the relevant keys, but I was getting an error when I tried to do this. I think it is a bit picky about how things are typed out/formatted in the bib file...

[rtimms]

Yeah, e.g doing

print(pybtex.format_from_file("pybamm/CITATIONS.txt", "unsrt", citations=["sulzer2020python", "harris2020array"], output_backend="plaintext"))   

works, but if you don't pass the citations argument (so that it print all citations) it fails. Think it will be a boring job of fixing commas etc, but then in future we can test to make sure it prints ok so that you just fix a single entry.

[brosaplanella]

Sounds good! It seems that in order to print all the citations you need to pass "[*]". I am happy to give it a go as it lines up with #1182 which I need to tackle at some point.