Reproducibility Service for Executable Research Compendia: Technical Specifications and Reference Implementation

This project contains the source code and documentation of a webservice and user interface for creation and inspection of Executable Research Compendia (ERC). This software is a reference implementation developed by the team of the project Opening Reproducible Research (o2r) at the University of Münster, Germany. This work preserves data currently available online on GitHub (https://github.com/o2r-project/) and described at https://o2r.info/results/ beyond the project duration.

Besides PDFs of specifications and documentation and the full source code of all projects' code repositories (including history), this record includes container images of all required software to allow a reproduction of the environment described in a forthcoming scientific article.

To run the reference implementation, please follow the instructions in the file README.md.

File listing and description:

• erc-spec.pdf: Executable Research Compendium specification, see online at http://o2r.info/erc-spec
• Makefile: main control file for packaging and reproduction
• o2r-architecture.pdf: Opening Reproducible Research System Architecture documentation, see online at http://o2r.info/architecture/
• o2r-docs.zip and o2r-reference-implemntation-modules.zip: source code repositories for ERC specification, API documentation, architecture documentation, ERC examples, and all software, see online at https://github.com/o2r-project
• o2r-reference-implementation-files.zip: configuration files and scripts for creation of this package and reproduction
• o2r-reference-implementation-images.tar.gz: tarball of the Docker images of all tools and microservices used by the reference implementation
• o2r-web-api.pdf: Opening Reproducible Research API specification, see online at https://o2r.info/api/
• README-WIN.md: Reproduction instructions specific to Windows users
• README.md: Reproduction instructions and description of the creation process for this package
• versions.txt: Version numbers and version control hashes for all projects

o2r is funded by the German Research Foundation (Deutsche Forschungsgemeinschaft, DFG) under project numbers PE 1632/10-1, KR 3930/3-1, TR 864/6-1, PE 1632/17-1, KR 3930/8-1, and TR 864/12-1.