Callback

[valentinsulzer]

Description

Add callback hooks to Simulation.solve and a move some logging steps to the callback

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist:

• No style issues: $ flake8
• All tests pass: $ python run-tests.py --unit
• The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[codecov]

Codecov Report

Merging #1880 (d9667d0) into develop (3cd7388) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head d9667d0 differs from pull request most recent head 228fcb0. Consider uploading reports for the commit 228fcb0 to get more accurate results

@@             Coverage Diff             @@
##           develop    #1880      +/-   ##
===========================================
- Coverage    99.37%   99.35%   -0.02%     
===========================================
  Files          347      347              
  Lines        19136    18735     -401     
===========================================
- Hits         19016    18615     -401     
  Misses         120      120              

Impacted Files	Coverage Δ
pybamm/__init__.py	100.00% <100.00%> (ø)
pybamm/callbacks.py	100.00% <100.00%> (ø)
pybamm/logger.py	100.00% <100.00%> (ø)
pybamm/simulation.py	98.56% <100.00%> (+0.06%)	⬆️
pybamm/solvers/solution.py	100.00% <100.00%> (ø)
pybamm/util.py	100.00% <100.00%> (ø)
pybamm/models/base_model.py	99.23% <0.00%> (-0.03%)	⬇️
pybamm/solvers/casadi_solver.py	98.23% <0.00%> (-0.02%)	⬇️
pybamm/parameters/parameter_values.py	99.44% <0.00%> (-0.02%)	⬇️
... and 8 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0ce0a71...228fcb0. Read the comment docs.

[valentinsulzer]

@martinjrobins I think this could be useful for automatically uploading simulation results from a script

[brosaplanella]

Looks good, thanks Tino! I guess we should extend the example notebook but we can do this in the future. Before merging, you need to update CHANGELOG.