You Only Write Thrice: Creating Documents, Computational Notebooks and Presentations From a Single Source
Description
Academic trade requires juggling multiple variants of the same content published in different formats: manuscripts, presentations, posters and computational notebooks. The need to track versions to accommodate for the write--review--rebut--revise life-cycle adds another layer of complexity. We propose to significantly reduce this burden by maintaining a single source document in a version-controlled environment (such as git), adding functionality to generate a collection of output formats popular in academia. To this end, we utilise various open-source tools from the Jupyter scientific computing ecosystem and operationalise selected software engineering concepts. We offer a proof-of-concept workflow that composes Jupyter Book (an online document), Jupyter Notebook (a computational narrative) and reveal.js slides from a single markdown source file. Hosted on GitHub, our approach supports change tracking and versioning, as well as a transparent review process based on the underlying code issue management infrastructure. An exhibit of our workflow can be previewed at https://so-cool.github.io/you-only-write-thrice/.
Notes
Files
So-Cool/you-only-write-thrice-v1.zip
Files
(25.4 kB)
Name | Size | Download all |
---|---|---|
md5:7eb6b027ad9834b0a7fa3f3d0db6a622
|
25.4 kB | Preview Download |
Additional details
Related works
- Is supplement to
- Presentation: https://github.com/So-Cool/you-only-write-thrice/tree/v1 (URL)
- Report: https://so-cool.github.io/you-only-write-thrice/ (URL)
Funding
References
- Sokol, K., & Flach, P. (2021). You Only Write Thrice: Creating Documents, Computational Notebooks and Presentations From a Single Source. In Beyond static papers: Rethinking how we share scientific understanding in ML – ICLR 2021 workshop.
- Sokol, K., & Flach, P. (2021). You Only Write Thrice: Creating Documents, Computational Notebooks and Presentations From a Single Source. arXiv preprint arXiv:2107.06639.