Create a Detailed Technical Diagram

[PipGrylls]

We need to generate a detailed UML (Unified Modelling Language) diagrams to show the class inheritance/composition and relational structures within PyBOP.

[PipGrylls]

My intention is to use UML as it is a reasonable standard and can be programatically created.

I use VSCode and will trial using the following tool extension. UML being a standard other tools/renderers are available.

I want to create a high level model showing the expected composition of a ‘full PyBOP’ from model though optimiser. This will be low on detail.

I want then to create detailed diagrams where we are composing/inheriting PyBamm to be able to map those relationships closely.

Additionally I will look at a way (with minimal effort duplication from the above) to create bundles of PyBOP classes that expose given functionality.

I will keep this on the issue branch that will track development, we can PR completed diagrams when we are happy with the result.

Suggestions for not using UML/an alternative welcome.

[PipGrylls]

https://github.com/pybop-team/PyBOP/blob/UML/assets/uml_diagrams/src/auto-gen/pybamm/model-classes.plantuml
Can someone review this for me, its a UML of pybamm.models, I’ve commented out a great deal of it as I thought it wasn’t relevant to the overall diagram in which I will show the links between PyBOP.models and pybamm.models.
I am concerned that I may have missed relationships so someone with more PyBamm familiarity may be able to help.

[martinjrobins]

In terms of interactions between pybop and pybamm, I think the important pybamm classes are:

• pybamm.BaseModel (ideally pybop should not care which model its wrapping, but we might need the more specific battery models as well, pybamm.BaseBatteryModel, pybamm.lithium_ion.BaseModel, pybamm.equivalent_circuit.Thevenin)
• pybamm.ParameterValues (part of the pybamm pipeline, replaces symbolic params with concrete numbers)
• pybamm.Discretisation. Discretises a pybamm model, replacing symbolic derivatives and variables with matrices/vectors
• pybamm.BaseSolver. Base class for solvers. Individual solvers have additional functionality so you might need the derived classes too (pybamm.IDAKLUSolver, pybamm.IDAKLUJax, pybamm.CasadiSolver)

thats the main ones I can think of so far!