Sharing and Publishing Jupyter Notebooks: Glossary

Your code tells what you did. Your documentation tells why you did it and why it is important.

Documentation is the key to communicating your workflow and findings with your future self, collaborators, peers, and the general public.

Jupyter Notebooks are powerful because it allows documenting the what (the code) and the why (the motivation and/or intepretation) interspersed with each other.

Good, better, best: Some metadata are already much better than none, more metadata make better metadata.

Jupyter Notebooks can be converted to a number of formats relevant for scholarly communication and publishing, including HTML, PDF, and Markdown.

Some code repositories, including GitHub, “know” how to render Jupyter Notebook format natively, and hence can be used for publishing notebooks for public viewing.

Research inputs such as data, source code, and notebooks that become digitally unavailable or inaccessible due to insufficient archiving for perpetuity are a major impediment to reproducibility.