Skip to main content

A workflow for open-source scientific articles

Project description

showyourwork
tests tests

NOTE: This is the bleeding-edge version of showyourwork, to be released as v0.3.0 in late May or 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

showyourwork-0.3.0.dev3.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

showyourwork-0.3.0.dev3-py3-none-any.whl (287.7 kB view details)

Uploaded Python 3

File details

Details for the file showyourwork-0.3.0.dev3.tar.gz.

File metadata

  • Download URL: showyourwork-0.3.0.dev3.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for showyourwork-0.3.0.dev3.tar.gz
Algorithm Hash digest
SHA256 714a14e92b4c0f31e8e1ac881ea02d9e2bb991aef93ee74c7c517ed59f01f27b
MD5 240cbdcd26628fef20c28f77aa2e6ede
BLAKE2b-256 3ca3aac532c14be6ae782d24416a59975a07713bc8f115ee54a43c4c9540ed85

See more details on using hashes here.

File details

Details for the file showyourwork-0.3.0.dev3-py3-none-any.whl.

File metadata

File hashes

Hashes for showyourwork-0.3.0.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 c6fafa25cb45ac289624279421b1c5a6f1ad0055fe3cbd9c1bb94128b4649f6e
MD5 c7a9c53dd93b98256ab21f9f3537fba0
BLAKE2b-256 f966872d87fc256be4f36d4054a40f64e9b8f3e89c5dfa7b1733543b17ed7ca5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page