Jupyter notebooks version control

[cmichelenstrofer]

Always clear the notebook before committing. Never commit output cells.

Do this automatically with a pre-commit hook.

1. Install extension

pip install jupyter_contrib_nbextensions

2. Create file.git/hooks/pre-commit:

#!/bin/sh
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace examples/*.ipynb
git add .

This will look for all Jupyter notebooks in the examples folder.

3. Make file an executable

chmod +x .git/hooks/pre-commit

[cmichelenstrofer]

If there are no output cells, nbsphinx will run the notebooks when creating the documentation. So the tutorials ideally don't take too long to run.

[rgcoe]

For reference, here's some more explanation of how this works: https://medium.com/somosfit/version-control-on-jupyter-notebooks-6b67a0cf12a3