Jupyter Binder Use Case

Tag without page: best-practice

Tag without page: open-science

Tag without page: reproducibility

This document is part of a collection of use cases.


Jane has written a (math) paper based on experimentations. She would like anyone to be able to reproduce her calculations.

Suggestion of solution:

Describe the experimentation as Jupyter notebooks, mixing prose, code, and outputs (think of them as logbooks). Publish them on a public repository (e.g. on GitHub, and make that repository binder-ready. Make the paper itself active (TODO: latexml+thebe?).

If executing the examples requires a non-trivial instal/build step, also consider using a Dockerfile, and auto-building the Docker image on https://hub.docker.com/.


Time and expertise required

Assuming Jane is familiar with version control and Jupyter (basic lab skills taught at Software Carpentry), and that the experiments were prepared as notebooks, the publishing part could take two hours the first time, and half an hour later on.

What’s new since OpenDreamKit started:

OpenDreamKit contribution