Notebooks cleanup / CI step
With 3e069e38 (and following), the notebooks from dpsim-validation were moved to this repo and a CI step that converts them to HTML was added. But this currently has some issues: some of them just display results of Cxx examples, and the notebooks aren't executed again (leading to some notebooks failing right now because of changed paths). Additionally, some notebooks depend on the reference results, which should be kept out of this repo.
Since I think that both executing the normal notebooks and comparing results with the reference results as part of CI would be beneficial, I'd suggest the following:
Go through the notebooks in Examples and ensure that they all work standalone (without needing external results either from our Cxx examples or the reference results), then change the test:jupyter CI step to also execute them (can be easily done with the
--executeflag of nbconvert).
Move the notebooks which depend on the reference results to dpsim-validation or just rewrite them as normal python scripts and execute them as part of a CI step there, reporting a failure if the deviation to the reference results is too big.
We'd basically have two separate stages then: in dpsim, the CI only checks that all examples can be executed, and in dpsim-validation, it ensures that the results are actually correct. The validation step would however only be triggered when explicitly updating the dpsim submodule in dpsim-validation.