CRC 1456 LiveDocs - from Knowledge to Dialogue on FAIR¹ Science
To promote open and reproducible research, the CRC 1456 projects offer their analysis results through showcases using LiveDocs. LiveDocs are reproducible environments crafted based on CRC 1456 projects’ repositories, with the intent of providing the general public with access to the code and data used in projects’ analysis, thus allowing the reproduction of reported results.
LiveDocs operate under the principle of providing everything needed for the general audience to be able to interact with your code, either for scientific divulgation purposes or to spread awareness on specific themes (but its usage is not limited to these two cases).
LiveDocs are provided in a ready-to-run format, which facilitates the code execution across many platforms. As for the involved technologies, currently, the LiveDocs can be delivered in one or more of the following formats:
Binderized applications running either in the Private or Public CRC 1456 Binderhub Servers in:
Jupyter Lab server
Jupyter Notebook (Classic) server
Jupyter server with Voilá
Applications that run locally in the browser, using JupyterLite
Static HTML generated from Jupyter Scripts
Containerized applications for Docker
LiveDocs Template
At the CRC 1456 Gitlab, the INF project provides a template for you to create your LiveDocs in the GWDG Gitlab. This template coitains the backbone of a LiveDocs project, with the necessary files and configurations to create a LiveDocs from scratch, along with a guided tour on LiveDocs in the form of a Jupyter Notebook.
You can download this repository and start working on it. More information can be found in its readme file.
If you are a CRC 1456 member and have questions on how to create a LiveDoc of your own, or about any specificities concerning the LiveDocs, please contact us.
Note
¹ FAIR stands for Findable, Accessible, Interoperable and Reusable. For more information, please visit the GO FAIR website.