https://github.com/showyourwork/showyourwork

A workflow for reproducible and open scientific articles
https://github.com/showyourwork/showyourwork

continuous-integration latex open-source reproducible-research reproducible-science scientific-papers scientific-workflows

Last synced: 3 months ago
JSON representation

A workflow for reproducible and open scientific articles

• Host: GitHub
• URL: https://github.com/showyourwork/showyourwork
• Owner: showyourwork
• License: mit
• Created: 2021-07-06T19:25:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T23:13:11.000Z (7 months ago)
• Last Synced: 2024-04-16T18:23:36.979Z (7 months ago)
• Topics: continuous-integration, latex, open-source, reproducible-research, reproducible-science, scientific-papers, scientific-workflows
• Language: TeX
• Homepage: https://show-your.work
• Size: 13.7 MB
• Stars: 531
• Watchers: 5
• Forks: 43
• Open Issues: 63
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.rst
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        


    

        

    

    


    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



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](https://showyourwork.readthedocs.io) for more information about this project. The [quickstart tutorial](https://showyourwork.readthedocs.io/en/latest/quickstart) should get you up and running fairly quickly with a simple workflow. Dig deeper by reading about the [command line interface](https://showyourwork.readthedocs.io/en/latest/cli), the [recommended project layout](https://showyourwork.readthedocs.io/en/latest/layout), the workflow [configuration file](https://showyourwork.readthedocs.io/en/latest/config), and details about the [integration with LaTeX](https://showyourwork.readthedocs.io/en/latest/latex). You can also check out a list of example projects that use `showyourwork!` [here](https://showyourwork.readthedocs.io/en/latest/projects).

`showyourwork!` is a work in progress, so please look over the [issues page](https://github.com/showyourwork/showyourwork/issues) if you think you’ve spotted a bug, and feel free to [raise a new issue](https://github.com/showyourwork/showyourwork/issues/new) if needed! Community contributions are also most welcome. Make sure to check out our new [discussion board](https://github.com/showyourwork/showyourwork/discussions)!