Issue 865 interface

[valentinsulzer]

Description

Reformatted interface submodels.

Fixes #865

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 #866 into develop will increase coverage by 0.03%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop     #866      +/-   ##
===========================================
+ Coverage    97.66%   97.70%   +0.03%     
===========================================
  Files          207      201       -6     
  Lines        10510    10415      -95     
===========================================
- Hits         10265    10176      -89     
+ Misses         245      239       -6     

Impacted Files	Coverage Δ
...bmodels/interface/first_order_kinetics/__init__.py	100.00% <0.00%> (ø)

---

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 bf5283c...099631a. Read the comment docs.

[rtimms]

thanks @tinosulzer the structure for the kinetics is now much clearer!

the only comment I have is that having the if statements for things like _get_exchange_current_density could get long if people start adding lots more reactions. I think it is ok for now though. maybe a solution is to have a reactions class that gets instatiated inside the init of base_interface so that the definitions of _get_exchange_current_density are shifted to separate files. I know we had separate files for lithium-ion main, lead-acid main etc. before but they had definitions of classes at the end with double inheritence, which I found confusing.

Anyway I think what you've done looks great and clears things up a lot, and we can revisit the reactions if and when people start to implement a lot more.

[rtimms]

both lead acid and lithium ion?

[valentinsulzer]

Thanks, yeah I didn't know how to keep it with separate classes but not do double inheritance, can rethink again if it becomes too long