Technologies in EDS Book Notebooks
Technologies in EDS Book Notebooks¶
This section indicates the main technologies for peer-reviewing and sharing EDS book notebooks.
The interaction between authors and reviewers in the notebook repository is facilitated through ReviewNB, a third-party plugin in GitHub for displaying and commenting Jupyter Notebooks. Sharing and viewing the content is faster in ReviewNB than with any other online platform e.g. Binder. Also, it easily renders Jupyter Notebook rich diffs than GitHub (see here). The inline review comments interface is useful and user-friendly. While it supports major visualisation libraries and interactive widgets, it does not render certain libraries for interactive charts and plots e.g. Bokeh.
In addition to ReviewNB, other platforms which facilitates the reviewing are:
notebooksharing.space (optional at the review stage): supports bokeh-related widgets. Reviewers can ask the author to upload the notebook in this platform to inspect the interactive content not rendered in ReviewNB. Note the notebook file is limited up to 10 MB.
Netlify previews (only at the post-print stage): a preview hosted by Netlify can be also inspected in the pull request of the contribution.
Let’s highlight below the main features of ReviewNB according to its official documentation:
Visual diff for every commit or pull request containing Notebooks
Commenting on the notebook diff to start discussion
Conversation threads to track all open discussions
Team conversations directly on Jupyter Notebooks
In EDS book, we use ReviewNB in the review step. Once Editors-in-Chief or reviewers open a PR in the notebook repository, it will include a link to view changes on ReviewNB.
You can find further information of latest ReviewNB developments in https://blog.reviewnb.com/.
Research objects and RoHub¶
Research objects (ROs) are living resources helping to organise and describe the inputs, materials, and methods used in a scientific experiment and obtained as a result and not only at the end when publishing the research outcomes.
RoHub is a Research Object management platform that enables researchers to collaboratively manage, share and preserve their research work (data, software, workflows, models, presentations, videos, articles, etc.). RoHub implements the full RO model and paradigm: resources associated to a particular research work are aggregated into a single FAIR digital object, and metadata relevant for understanding and interpreting the content is represented as semantic metadata that are user and machine readable.
All EDS book notebooks are findable in RoHub. RoHub allows tracking all research life cycle and derivate work of EDS book notebooks (from the notebook idea to post-publication). In addition, the platform allows sharing, publishing and citing EDS book notebooks.
For further details of RoHub, we suggest visiting its portal documentation here which contains some examples published by the EDS book community.