Code example in README

[TobyBoyne]

Closes #409

Adds some examples of BoFire code (from the getting started notebook) to the README.

[bertiqwerty]

Thanks, Toby!

[bertiqwerty]

I just saw that one missing import makes the test fail. Further, you could put all imports to the top.

[jduerholt]

Test is failing due to a new scipy release from today. I try to figure it out this evening. Thanks @TobyBoyne!

[jduerholt]

scipy.integrate.simps was renamed to scipy.integrate.simpson in todays stable 1.13 release.

[TobyBoyne]

scipy.integrate.simps was renamed to scipy.integrate.simpson in todays stable 1.13 release.

Thank you for investigating this @jduerholt! Will you be fixing this in the main branch? If so, please let me know once you have, and I will merge the changes.

[jduerholt]

Hi Toby, the fix is now available in Main. Best, Johannes

[TobyBoyne]

@bertiqwerty The fix has been merged, and this is now ready to close (if you're happy with my comment about moving all imports to the top, copied below)

Re: imports, I think it's clearer if the imports are in their own cells (in the same way as the Getting Started notebook), so that it is clearer which module relates to what functionality. It also might be intimidating to have 7 lines of import statements at the very top.
If you feel strongly about this, happy to change it!

[bertiqwerty]

Thanks Toby!