sandialabs / WecOptTool

WEC Design Optimization Toolbox
https://sandialabs.github.io/WecOptTool/
GNU General Public License v3.0
13 stars 22 forks source link

tracking changes on Jupyter notebooks #112

Closed cmichelenstrofer closed 2 years ago

cmichelenstrofer commented 2 years ago

We shouldn't be pushing the notebooks with results. There is a workaround. nbsphinx runs notebooks by default! Only downside is that building the docs could now take a long time.

Approach shared by Hannasch, David Alexander:

For Jupyter it's mainly just a matter of scrubbing the outputs. you can add

[filter "strip-jupyter-notebook-output"]
clean = "jupyter nbconvert --ClearOutputPreprocessor.enabled=True --to=notebook --stdin --stdout --log-level=ERROR"

of course, when you're only committing the un-executed version you'll want a gitlab-runner to automatically execute and post the Jupyter notebook on each commit, so that you can look at the executed version, like http://video-anomaly-detection.cee-gitlab.lan/video-anomaly-detection-notebooks/quickstart.html)

cmichelenstrofer commented 2 years ago

completed/fixed in v2.0