Data

Tools

Indexes

Applications

Experiments

Open Source Science

better-research-software

Building Better Research Software

https://github.com/carpentries-incubator/better-research-software

Science Score: 67.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
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: nature.com, zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.0%) to scientific vocabulary

Keywords

beta carpentries-incubator english fair fair-software lesson research-software
Last synced: 6 months ago · JSON representation ·

Repository

Building Better Research Software

Basic Info
Statistics
  • Stars: 12
  • Watchers: 12
  • Forks: 16
  • Open Issues: 44
  • Releases: 3
Topics
beta carpentries-incubator english fair fair-software lesson research-software
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Authors

README.md

DOI

Building Better Research Software

This short course is teaching tools and practices for producing and sharing quality, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software to support open and reproducible research.

The lesson uses the which gradually gets improved over the course of this lesson following the good software practices we teach. The better code the lesson finishes with can be found at the "final" branch of the software project repository.

The lesson uses the example software project that does not follow good research software practices and has no documentation which learners “inherit” from a pretend team member that has left the team/organisation. Learners need to read and understand the software and improve it gradually over the course of this lesson following the good software practices the course teaches - including using reproducible software environments and version control, improving code readability and structure, adding tests and documentation to the code and learning about open software management & collaboration.

The course can be delivered over 2 full or 4 half days.

The accompanying slides to aid with course delivery are also available.

Launch this lesson on myBinder! 👉 Binder

Contributing

Please see the CONTRIBUTING.md for contributing guidelines and details on how to get involved with this project.

Also see the current list of issues for ideas for contributing to this training curriculum. Look for the tag good_first_issue. This indicates that the issue does not require in-depth knowledge of the project and lesson infrastructure, and is a good opportunity for a new contributor to get involved.

To learn more about how this lesson site is built and how you can edit the pages, see the Introduction to The Carpentries Workbench.

Author(s)

The list of authors of the course is available in CITATION.cff.

Maintainer(s)

Current maintainers of this lesson are:

Citation

Gibson, S., Goel, A., Jaffa, S., Kopec-Harding, K., Nenadic, A., & Sauze, C. (2025). Software practices for open and reproducible research (beta-May-2025). Zenodo. https://doi.org/10.5281/zenodo.15490720

Information on how to cite this work is also available in CITATION.cff.

Contact

Please get in touch with Aleksandra Nenadic with any questions about this lesson.

Acknowledgements

This work has been supported by the UK's Software Sustainability Institute via the EPSRC, BBSRC, ESRC, NERC, AHRC, STFC and MRC grant EP/S021779/1 and UK Reproducibility Network (UKRN).

Owner

  • Name: carpentries-incubator
  • Login: carpentries-incubator
  • Kind: organization

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Building Better Research Software
message: >-
  Curriculum for the "Building Better Research Software"
  workshop
type: dataset
authors:
  - given-names: Sarah
    family-names: Gibson
    orcid: 'https://orcid.org/0000-0003-0356-2765'
  - given-names: Aman
    family-names: Goel
    orcid: 'https://orcid.org/0000-0003-3567-2096'
  - given-names: Toby
    family-names: Hodges
    affiliation: The Carpentries
    orcid: 'https://orcid.org/0000-0003-1766-456X'
  - given-names: Sarah
    family-names: Jaffa
  - given-names: Kamilla
    family-names: Kopec-Harding
  - given-names: Aleksandra
    family-names: Nenadic
    affiliation: >-
      Software Sustainability Institute / The University of
      Manchester
    orcid: 'https://orcid.org/0000-0002-2269-3894'
  - given-names: Colin
    family-names: Sauze
  - given-names: Sarah
    family-names: Stevens
    affiliation: The University of Wisconsin-Madison
    orcid: 'https://orcid.org/0000-0002-7040-548X'
identifiers:
  - type: url
    value: 'https://doi.org/10.5281/zenodo.12666088'
    description: Zenodo DOI record for most recent lesson release
repository-code: >-
  https://github.com/carpentries-incubator/better-research-software/tree/main
url: >-
  https://carpentries-incubator.github.io/better-research-software/index.html
abstract: >-
  A  course on tools and practices for developing and
  collaborating on open, sustainable and FAIR (Findable,
  Accessible, Interoperable and Reusable) research software.
keywords:
  - FAIR
  - research software
  - good practices
  - Carpentries Incubator
license: CC-BY-4.0
version: beta-May-2025
date-released: '2025-05-22'

GitHub Events

Total
  • Create event: 33
  • Release event: 1
  • Issues event: 23
  • Delete event: 14
  • Issue comment event: 37
  • Push event: 131
  • Pull request review event: 30
  • Pull request review comment event: 26
  • Pull request event: 32
  • Fork event: 2
Last Year
  • Create event: 33
  • Release event: 1
  • Issues event: 23
  • Delete event: 14
  • Issue comment event: 37
  • Push event: 131
  • Pull request review event: 30
  • Pull request review comment event: 26
  • Pull request event: 32
  • Fork event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 20
  • Average time to close issues: 21 days
  • Average time to close pull requests: 4 days
  • Total issue authors: 4
  • Total pull request authors: 5
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.65
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 14
  • Pull requests: 20
  • Average time to close issues: 21 days
  • Average time to close pull requests: 4 days
  • Issue authors: 4
  • Pull request authors: 5
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.65
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • sstevens2 (7)
  • anenadic (5)
  • tobyhodges (1)
  • SJaffa (1)
Pull Request Authors
  • tobyhodges (7)
  • anenadic (6)
  • sstevens2 (5)
  • warrickball (1)
  • eroesch (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/pr-close-signal.yaml actions
  • actions/upload-artifact v3 composite
.github/workflows/pr-comment.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
  • carpentries/actions/download-workflow-artifact main composite
.github/workflows/pr-post-remove-branch.yaml actions
  • carpentries/actions/download-workflow-artifact main composite
  • carpentries/actions/remove-branch main composite
.github/workflows/pr-preflight.yaml actions
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
.github/workflows/pr-receive.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/sandpaper-main.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-cache.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-lockfile main composite
  • carpentries/create-pull-request main composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-workflows.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-workflows main composite
  • carpentries/create-pull-request main composite
.binder/requirements.txt pypi
  • pandoc *