showyourwork

A workflow for reproducible and open scientific articles

https://github.com/showyourwork/showyourwork

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
6 of 33 committers (18.2%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary

Keywords

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

Keywords from Contributors

exoplanets astrophysics astronomy physics mcmc bayesian-inference dynamics gaussian-processes jax astropy-affiliated

Last synced: 6 months ago · JSON representation ·

Repository

A workflow for reproducible and open scientific articles

Basic Info

Host: GitHub
Owner: showyourwork
License: mit
Language: TeX
Default Branch: main
Homepage: https://show-your.work
Size: 13.5 MB

Statistics

Stars: 611
Watchers: 9
Forks: 54
Open Issues: 67
Releases: 49

Topics

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

Created over 4 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog License Citation

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. You can also check out a list of example projects that use showyourwork! here.

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. Make sure to check out our new discussion board!

Owner

Name: showyourwork!
Login: showyourwork
Kind: organization
Location: United States of America

Website: https://show-your.work
Repositories: 10
Profile: https://github.com/showyourwork

A suite of tools for enabling open source and reproducible science

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use showyourwork!, please cite it as below."
authors:
  - family-names: "Luger"
    given-names: "Rodrigo"
    orcid: "https://orcid.org/0000-0002-0296-3826"
title: "showyourwork!"
version: 0.3.0
date-released: 2022-06-01
url: "https://github.com/showyourwork/showyourwork"
preferred-citation:
  type: article
  authors:
    - family-names: "Luger"
      given-names: "Rodrigo"
      orcid: "https://orcid.org/0000-0002-0296-3826"
    - family-names: "Bedell"
      given-names: "Megan"
      orcid: "https://orcid.org/0000-0001-9907-7742"
    - family-names: "Foreman-Mackey"
      given-names: "Daniel"
      orcid: "https://orcid.org/0000-0002-9328-5652"
    - family-names: "Crossfield"
      given-names: "Ian J. M."
      orcid: "https://orcid.org/0000-0002-1835-1891"
    - family-names: "Zhao"
      given-names: "Lily L."
      orcid: "https://orcid.org/0000-0002-3852-3590"
    - family-names: "Hogg"
      given-names: "David W."
      orcid: "0000-0003-2866-9403"
  journal: "arXiv e-prints"
  title: "Mapping stellar surfaces III: An Efficient, Scalable, and Open-Source Doppler Imaging Model"
  url: "https://arxiv.org/abs/2110.06271"
  year: 2021

GitHub Events

Total

Create event: 45
Issues event: 36
Watch event: 46
Delete event: 42
Member event: 1
Issue comment event: 102
Push event: 108
Pull request review comment event: 11
Pull request review event: 9
Pull request event: 107
Fork event: 7

Last Year

Create event: 45
Issues event: 36
Watch event: 46
Delete event: 42
Member event: 1
Issue comment event: 102
Push event: 108
Pull request review comment event: 11
Pull request review event: 9
Pull request event: 107
Fork event: 7

Committers

Last synced: about 2 years ago

All Time

Total Commits: 1,392
Total Committers: 33
Avg Commits per committer: 42.182
Development Distribution Score (DDS): 0.185

Past Year

Commits: 83
Committers: 21
Avg Commits per committer: 3.952
Development Distribution Score (DDS): 0.711

Top Committers

Name	Email	Commits
Rodrigo Luger	r**r@g**m	1,134
gh-actions	g****s	84
pre-commit-ci[bot]	6****]	41
Dan Foreman-Mackey	d**m@d**o	32
Dan F-M	f**y@g**m	28
dependabot[bot]	4****]	13
Miles Cranmer	m**r@g**m	13
math	m**0@g**m	5
Adrian Price-Whelan	a**w@g**m	5
Andrew McCluskey	a**w@m**t	4
Maximiliano Isi	i**i@g**m	4
John Franklin Crenshaw	j**w@g**m	3
Andrew McCluskey	a**y@e**u	3
Thomas Ng	t**g@l**k	2
Katie Breivik	k**3@u**u	2
Rachel Wegener	3****2	2
showyourwork	s****k	1
Will Barnes	w**s@g**m	1
Martin Schlecker	1****e	1
Mathieu Renzo	4****n	1
Pietro Monticone	3****e	1
Sterling G. Baird	4****d	1
Timothy Gebhard	t****d	1
Trevor David	1****d	1
Tom Wagg	t**g@g**m	1
Richard West	r**t@n**u	1
Miles Lucas	m**s@h**u	1
Michele Peresano	p**e@g**m	1
Louis Desdoigts	l**5@u**u	1
Lehman Garrison	l**n@f**g	1
and 3 more...

Committer Domains (Top 20 + Academic)

flatironinstitute.org: 1 uni.sydney.edu.au: 1 hawaii.edu: 1 northeastern.edu: 1 u.northwestern.edu: 1 link.cuhk.edu.hk: 1 ess.eu: 1 mccluskey.scot: 1 dfm.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 116
Total pull requests: 209
Average time to close issues: 3 months
Average time to close pull requests: 11 days
Total issue authors: 31
Total pull request authors: 21
Average comments per issue: 2.71
Average comments per pull request: 0.54
Merged pull requests: 171
Bot issues: 0
Bot pull requests: 113

Past Year

Issues: 21
Pull requests: 104
Average time to close issues: about 2 months
Average time to close pull requests: 3 days
Issue authors: 5
Pull request authors: 5
Average comments per issue: 2.05
Average comments per pull request: 0.11
Merged pull requests: 86
Bot issues: 0
Bot pull requests: 75

View more stats

Top Authors

Issue Authors

HealthyPear (26)
dfm (17)
mkenworthy (14)
MilesCranmer (12)
nstarman (5)
outs1der (4)
arm61 (4)
thomasckng (4)
jfcrenshaw (3)
TobiBu (2)
ciskakemper (2)
rodluger (2)
maxisi (2)
rwegener2 (2)
nikosarcevic (1)

Pull Request Authors

pre-commit-ci[bot] (95)
HealthyPear (35)
dependabot[bot] (33)
dfm (23)
MilesCranmer (9)
thomasckng (9)
arm61 (5)
maxisi (4)
rwegener2 (2)
mileslucas (2)
sgbaird (1)
adrn (1)
wtbarnes (1)
TrellixVulnTeam (1)
matiscke (1)

Top Labels

Issue Labels

:arrow_up: enhancement (33) :hand: contributions welcome (33) :calendar: hack day (21) :memo: documentation (20) :bug: bug (19) :bulb: ideas (13) :eye: example (11) zenodo (7) needs triage (6) :alarm_clock: waiting for more info (5) :new: good first issue (5) :test_tube: testing (4) :construction: v1.0 (4) known issue (3) :truck: infrastructure (2) overleaf (1) tex (1) maintenance (1) remote (1) static (1) missing (1)

Pull Request Labels

dependencies (34) :memo: documentation (12) :arrow_up: enhancement (9) maintenance (9) fix (7) :test_tube: testing (4) no-changelog-needed (4) :construction: v1.0 (3) github_actions (2) known issue (2) github action (2) :truck: infrastructure (2) CLI (1) overleaf (1) remote (1) CI (1) :calendar: hack day (1) static (1)

Packages

Total packages: 1
Total downloads:
- pypi 125 last-month

Total dependent packages: 0
Total dependent repositories: 3
Total versions: 29
Total maintainers: 2

pypi.org: showyourwork

A workflow for open-source scientific articles

Homepage: https://github.com/showyourwork/showyourwork
Documentation: https://showyourwork.readthedocs.io/
License: MIT
Latest release: 0.4.3
published over 2 years ago

Versions: 29
Dependent Packages: 0
Dependent Repositories: 3
Downloads: 125 Last month

Rankings

Stargazers count: 2.9%

Forks count: 6.4%

Average: 7.2%

Dependent packages count: 7.3%

Dependent repos count: 9.1%

Downloads: 10.3%

Maintainers (2)

danfm rodluger

Last synced: 6 months ago

Dependencies

.github/workflows/local_integration_tests.yml actions

actions/checkout v3 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/publish.yml actions

actions/checkout v3 composite
actions/download-artifact v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
pypa/gh-action-pypi-publish release/v1 composite

.github/workflows/remote_integration_tests.yml actions

actions/checkout v3 composite
andymckay/labeler 3a4296e9dcdf9576b0456050db78cfd34853f260 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/unit_tests.yml actions

actions/checkout v3 composite
conda-incubator/setup-miniconda v2 composite

pyproject.toml pypi

click >=8.1.3
cookiecutter >=2.1.1
graphviz >=0.19.1
jinja2 >=3.0.3
packaging >=21.3
pyyaml >=6.0
requests >=2.25.1
snakemake ==7.15.2

src/showyourwork/cli/commands/setup.py pypi

docs/environment.yml conda

datrie
pip >=20.3.3
python 3.9.*

src/showyourwork/cookiecutter-showyourwork/{{ cookiecutter.repo }}/environment.yml pypi

matplotlib ==3.4.3

showyourwork

Science Score: 54.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: showyourwork

Rankings

Maintainers (2)

Dependencies