search

reproducible-reporting / reprepbuild

Build tool for Reproducible Reporting
GNU General Public License v3.0
1 stars 1 forks source link

readme

:rotating_light: IMPORTANT! :rotating_light:

The RepRepBuild repository became a public archive on Friday April 26, 2024. RepRepBuild will remain available but will no longer be developed. It is superseded by the StepUp Core and StepUp RepRep packages.

PyPI Upload pytest PyPI Version PyPI - Python Version GPL-3 License

RepRepBuild

RepRepBuild is the build tool for Reproducible Reporting. Run rr in a source directory, and the publication will be rebuilt from its source.

To get started, follow the documentation of the templates repository. RepRepBuild will be installed in your instance of the template, as part of the setup.

RepRepBuild emphasizes two kinds of reproducibility:

  1. Byte-for-byte reproducibility of the generated files. If the same inputs are used, the same files are produced. Irrelevant timestamps and other annoyances are eliminated for this purpose.
  2. Hands-free reproducible workflows for building publication files. Given the raw research results, anyone can regenerate plots, tables, and PDF files for a publication.

The first kind type of reproducibility helps with the second. When a file changes in the Git commit history, RepRepBuild tries to ensure that this is not the side effect of something irrelevant. This makes it easier to trace the origin of (changes to) results.

If you would like to contribute, please read CONTRIBUTING.md.