To re-create the environment as a Jupyter kernel for execution of the notebooks, do the following:
- Open a Terminal from the same level as this Markdown README file and the Makefile file.
- Type the following into the terminal.
make kernel
Select the kernel with the equivalent name as the .ipynb notebook to execute the notebook. For example, 01_lecture.ipynb requires the kernel 01_lecture for execution of the code blocks.
To remove Jupyter checkpoints run:
make clean
In order to remove the Conda environments and Jupyter kernels runL
make teardown
Commit notebooks without output for smaller file sizes and interactive teaching. For convenience use nbstripout to clean notebooks, like so:
pip install nbstripout
nbstripout **/*.ipynb
Check you code for correct syntax as we want to show off good practices. You can use flake8-nb to check your writing.
pip install flake8-nb
flake8-nb **/*.ipynb
The pre-commit hooks can be used to check whether outputs are empty. This can be achieved, like so:
pip install pre-commit
pre-commit install