I would suggest we use Mermaid (in Markdown/Sphinx) to render the diagram. As a first step, a Data Flow Diagram^1 should suffice. Instead of a prose description like:
The main module model.py builds the vehicles and delegates the calculation of motive and auxiliary energy, noise, abrasion and exhaust emissions to satellite modules. Once the vehicles are fully characterized, the set of calculated parameters are passed to inventory.py which derives life cycle inventories and calculates life cycle impact indicators. Eventually, these inventories can be passed to export.py to be exported to various LCA software.
We could have an interactive diagram linking to the different modules. The biggest pain-point in working with (LCA) research software is the input/output data, and much less the internal architecture of the program.
I would suggest we use Mermaid (in Markdown/Sphinx) to render the diagram. As a first step, a Data Flow Diagram^1 should suffice. Instead of a prose description like:
We could have an interactive diagram linking to the different modules. The biggest pain-point in working with (LCA) research software is the input/output data, and much less the internal architecture of the program.