search

SINTEF / oteapi-optimade

A plugin repository for OTE API implementing OPTIMADE strategies and capabilities.
https://SINTEF.github.io/oteapi-optimade
MIT License
2 stars 0 forks source link

Test example notebooks in CI #147

Open CasperWA opened 1 year ago

CasperWA commented 1 year ago

The example should be run at a part of the CI testing.

This repository already has an end-2-end test that does exactly this. No need to also run the tutorial. That said, the mkdocs-jupyter plugin allows for executing the notebooks upon building the documentation, hence this could act as a CI test for whether the notebook works or not. However, since a separate server is required and the notebook references localhost:80 it might be quite tricky to make it work properly. Hence, I'd consider it out-of-scope for this PR and writing this example, but definitely worth further investigation down the road.

Originally posted by @CasperWA in https://github.com/SINTEF/oteapi-optimade/issues/125#issuecomment-1549132402

Notebooks:

Update: PR #127 which introduced the dlite.ipynb also added execution test for it when building the documentation.