Documentation#

Welcome to showyourwork!, a workflow management tool for open source scientific articles. If you want to make your research article reproducible, extensible, transparent, or just downright awesome, you’ve found the right tool. showyourwork! automates your entire workflow, packaging it into a self-contained recipe that anyone can follow and—at the click of a button—use to reproduce your results.

Building articles with showyourwork!

Find an open source article you’d like to reproduce or tinker with? Build it in 3 easy steps.

  1. Install the latest version of showyourwork!:

    pip install -U showyourwork

  2. Clone the article repository (replace user and repo with the GitHub user name and repository name for the desired project):

    git clone https://github.com/user/repo
cd repo

  3. Build!

    showyourwork build

    Setting up the workflow...
Generating the article PDF...
Done!

After installing all the required packages and running any pipeline or figure scripts, this will generate the article PDF ms.pdf in the current working directory.

Check out the pages below for more information about this project. The quickstart tutorial should get you up and running fairly quickly with a simple workflow. Dig deeper by reading about the command line interface, the recommended project layout, the workflow configuration file, and details about the integration with LaTeX.

showyourwork! is an open source project hosted on GitHub. It is very much a work-in-progress, so please look over the issues page if you think you’ve spotted a bug, and feel free to raise a new issue if needed! Community contributions are also most welcome.

Contents#