Automated testing of user guide examples

GMLC-TDC / HELICS

Hierarchical Engine for Large-scale Infrastructure Co-Simulation (HELICS)

https://docs.helics.org/en/latest/

BSD 3-Clause "New" or "Revised" License

127 stars 41 forks source link

Automated testing of user guide examples #1894

Open trevorhardy opened 3 years ago

trevorhardy commented 3 years ago

Is your feature request related to a problem? Please describe. Since the user guide examples are a primary means of trying out HELICS and learning it's features, it would be useful if there was an automated way of ensuring they are always in a working state.

Describe the solution you'd like Find a way to add the user guide examples in the HELIX–Examples repository to an automated testing routine.

trevorhardy commented 7 months ago

Need to add flags that disable the creation of the graphs, change the logging level (maybe the default should be less verbose?) and do what we can to get them to run quickly.