Skip to the content ForoHackers
Log inJoin

Research software: start here

Research software
#3257 · · Quote · Report

Research software is the code written to produce, process or analyse research results: a simulation, a pipeline, a statistical script. A published finding often stands on it, so a bug can become a false conclusion. It is usually written by scientists, not software engineers, which makes basic practice (versioning, testing, documentation) the biggest gain.

Key concepts

  • Reproducibility: the same code and data give the same result for another person; record versions, seeds and environment.
  • Version control: Git history shows what produced which figure, and lets collaborators work together safely.
  • Testing numerical code: known solutions, conservation checks, regression tests and tolerances for floating-point results.
  • Environments and packaging: pinned dependencies, containers and clear installation steps keep code running for years.
  • Sharing and credit: a licence, a citable archive and a README let others reuse and cite the work.

Vocabulary

  • FAIR: the principle that data and software should be findable, accessible, interoperable and reusable.
  • Workflow manager: a tool that runs a chain of analysis steps and reruns only what changed.
  • Provenance: the record of how a result was produced, from input to output.
  • Technical debt: shortcuts in code that make later change slower and riskier.

What to study, in order

  1. Put an existing analysis under Git, with a README that says how to run it.
  2. Write tests for its core functions, using a case whose answer you know.
  3. Capture the environment in a lockfile or a container, and rerun it on a clean machine.
  4. Replace manual steps with a workflow or a script that regenerates every figure from raw data.
  5. Choose a licence, archive a release with a persistent identifier, and add a citation file.

Related tags

#version-control #testing #documentation #open-source #licensing

You are not logged in, so this goes up anonymously: no account, no name and no address is stored with it, and it may carry no link and no image. Log in or join to post under your name. Our web server's logs keep the address and time of every request for up to 14 days; to keep yours out of them, use Tor. To reach the staff in confidence, use the drop. Sign as a returning source (a key kept only in this browser)

Sending takes a few seconds here: your browser first works out a proof of work against spam.

Reply