Simulation run record

On this page

Copy this template into the research repository and replace the brackets. Do not convert an unexecuted instruction into a completed check.

Question and literature target#

  • Responsible human: [name or project role]
  • Question and intended use: [one specific comparison]
  • Paper, DOI, and passage: [equation, listing, figure, table, or benchmark case]
  • Relationship: [original example, adaptation, port, or attempted reproduction]
  • Differences from the publication: [inputs, model, calibration, software, numerical settings]
  • Target observable and comparison rule: [quantity, unit, aggregation/window, tolerance, rationale]

Inputs and environment#

  • Code repository and immutable commit: [URL and commit]
  • Software, dependency lock, solver, and adapter versions: [files]
  • Hardware, operating system, driver, and runtime: [details relevant to this run]
  • Model, geometry, mesh, parameter files, units, and coordinate convention: [paths and hashes]
  • Input data, source, version, access conditions, and reuse terms: [records]
  • Random seeds and replication plan: [values and how streams are assigned]
  • Solver tolerances, discretization, time steps, and termination rules: [values]

Execution and evidence#

  • Exact commands and working directory: [commands]
  • Start/end time and execution outcome: [timestamps, exit status, failures]
  • Outputs and logs: [shareable paths, units, checksums]
  • Verification checks: [actual result and what each check establishes]
  • Numerical sensitivity or convergence: [evidence or not assessed]
  • Comparison with the specified literature target: [numbers, uncertainty, discrepancies]
  • Interpretation limits: [what the run does not establish]

Review and sharing#

  • Work and checks performed by: [people and material agent/tool assistance]
  • Human review: [pending, reviewer/date, or recorded decision]
  • Open artifacts: [code, environment, model, parameter and result files]
  • Restricted artifacts retained elsewhere: [manifest only; no restricted content]
  • Publication or release authorization: [separate recorded decision if applicable]

View source on GitHub