Code Documentation

[eibar-flores]

Document and revise the code to render it more readable.

• Add docstrings to functions.
• Revise naming conventions for variables. Long descriptive names are preferred over abbreviations. See here for best practices.
• Maximize compliance with Julia Style guide

[moyner]

We could add Julia formatter to automatically make the code uniform

[eibar-flores]

I went through the documentation and again, it looks neat! Here is some points I gathered while exploring it:

Plans for populating missing entries

• We should plan what to add in the missing links: Getting Started button, the four feature banners (accurate an open, ...)
• We should also plan populating the NavBar, specially the introduction and manual.

A Typo:
The Cycling example is titled "Cycling a battery 40 times" but the [input json] instructs the simulation to cycle the cell only 3 times, see ./Control/numberOfCycles = 3. The example title should be corrected.

Consolidate example style
The cycling example is concise and clear, it probably has the lowest entry barrier for newcomers. However, the Battery example uses a hook API that makes the example harder to follow and understand, specially if these hooks have not been explained. I would suggest to simplify the Battery example, or remove it entirely if it overlaps with the well-described cycling example.

Additional examples

• Validation: super valuable. How to compare a simulation Voltage curve with an experimental one
• Degradation: How to run multiple cycles with the SEI model, and how to visualize SEI parameters (e.g. SEI thickness, SEI resistance).