BERIL Knowledge Wiki

Concept in Data Infrastructure, Provenance, and Research Practice

analysis-provenance-and-reproducible-outputs

Single-source. AI-generated wiki from AI-conducted research reports. Partially reviewed by scientists. See About This Wiki.

Sources cited
1 cross-project digest, listed in the margin
Relations
refines 1
Linked from
6 pages9 topics

A project can look reproducible while lacking the record that would let anyone rerun it. The central pitfalls digest documents two separate failures. In the first, outputs were committed while the code that produced them was not. In the second, the notebook executor reported success while saving no outputs. Both rest on single documented incidents rather than a corpus-wide audit, so their frequency across projects is not established 1. Related execution-side failures are covered in long-running-analysis-execution-reliability and silent-failure-modes-in-distributed-queries. The digest itself is summarized in pitfalls.

Committed Outputs Without Committed Code

Analyses run interactively in a Claude Code session, as a pure Python REPL rather than a committed .ipynb, can produce figures and data files that get staged and committed while the generating code lives only in the session transcript 1. The project then looks reproducible. The README references NB08/NB09/NB10, the runtime tables list them and the REPORT cites their findings, yet git log finds no notebook history for those names 1. Downstream reviewers who read the plan and REPORT at face value miss the gap 1. Committed artifacts and prose citations therefore do not establish provenance on their own 1.

The documented scale is a single project. Three “notebooks”, NB08, NB09 and NB10, which made up the entire Act II/III closing, existed only as outputs 1. Once the gap was identified, reconstruction took a few hours. The source notes it would have been far cheaper to write .ipynb cells in the first place 1.

Executor Success Without Retained Outputs

On this JupyterHub, jupyter nbconvert --to notebook --execute --inplace ... can exit with code 0 but leave the notebook file on disk with zero cell outputs 1. A successful exit status is therefore not evidence that an executed notebook records what it computed 1.

The source recommends not relying on --inplace to capture outputs. It gives two alternatives: write to a separate file via --output, or, for long-running production ingests, run the equivalent logic as a standalone Python script so that stdout/stderr stream to a log file 1.

Synthesis: A Working Standard

Taken together, the two incidents suggest the hypothesis that a reproducible analysis record needs two things beyond committed artifacts. The first is version-controlled code history for every analysis the REPORT cites. The second is outputs saved by a method that is checked separately from the executor’s exit status. The source documents each failure once and does not test this standard across projects 1. The standard refines the reviewer-facing checks discussed in adversarial-research-quality-assurance: a review that reads only the plan and REPORT can miss missing notebook history 1.

Open Directions

  • Audit cited notebooks against git history. For every notebook name cited in project REPORTs and READMEs, check whether git log shows committed history. This would establish whether the outputs-only gap documented for NB08/NB09/NB10 is isolated or recurrent 1.
  • Flag committed notebooks that lack outputs. Scan committed .ipynb files for notebooks that have execution metadata but zero cell outputs, and treat the hits only as candidates for investigation. The scan alone cannot show which executor or options were used, or why the outputs are missing. Attributing any case to the --inplace failure would need execution logs or a controlled rerun of that notebook 1.
  • Compare the two recommended alternatives. Run the same notebooks with --output to a separate file and as logged standalone scripts. This would confirm that both alternatives retain outputs in this environment 1.

Sources cited

  1. KBase Data Lakehouse: Common Pitfalls & Gotchaspitfalls · cited 15× · cross-project digest · primary source · refines