showyourwork 0.3.0.dev4

A workflow for open-source scientific articles

NOTE: This is the bleeding-edge version of showyourwork!, to be released as v0.3.0 in early June 2022. You can pip install the current pre-release, but note that some functionality is subject to change slightly between now and the official release.

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.

Please check out the documentation 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 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.