Skip to content

james-ennis/RepSeP

 
 

Repository files navigation

RepSeP

The Reproducible Self Publishing toolkit demonstrates how to reuse your favourite data analysis workflows in order to seamlessly include quasi-dynamic publication-quality output (e.g. figures, tables, or statistic reports) in the most common science communication formats. Currently we provide examples for:

  • Presentation Slides
  • A Poster
  • An Article

In these examples, analysis does not have to be initiated manually, and output elements do not have to be copied, manually scaled, styled, or otherwise manipulated. Data analysis is kept in one and only one place, and configurable styling is applied programmatically at the document or output element level. Data and code dependencies are monitored for update via checksums, and are either provided or specified, so that both the toolkit in its present incarnation - as well as your own derivatives - can be reproduced locally and autonomously by your colleagues, reviewers, students, and everybody else. As no binaries are tracked, publications built analogously to our examples are excellently suited for collaborative editing and version tracking, e.g. via Git.

Video Presentations

How To Self-Publish Reproducible Scientific Documents

  • Clone this repository: git clone git@github.com:TheChymera/RepSeP.git
  • Install the dependencies (listed below).
  • Edit the document files (slides.tex, poster.tex, article.tex) to contain your own research output.
  • Compile the documents, e.g.: ./compile slides
  • Distribute the output and links to your fork of this repository via your favourite outreach channels.

Dependencies

We distribute a full list of uniquely identifiable dependencies and their associated version constraints, in the format laid out by the Package Management Specificaton. Depending on your distribution (and/or package manager), you may find helpful isntructions on how to best install the dependencies below.

List of dependencies:

Note that it is likely that you'll have to install pythontex from source (gpoore/pythontex). To do this, clone the repo and follow the installation instructions.

Examples

Posters

About

Reproducible Self-Publishing - Demo Publications in the Most Common Formats

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TeX 86.3%
  • Python 10.8%
  • Shell 2.9%