Skip to content

docs: add formal LaTeX paper under paper/ - #210

Merged
kambleakash0 merged 1 commit into
mainfrom
docs/latex-paper-209
Sep 13, 2026
Merged

kambleakash0 merged 1 commit into
mainfrom
docs/latex-paper-209

Conversation

@kambleakash0

Copy link
Copy Markdown
Owner

Adds the submittable LaTeX write-up of the study as a standalone paper/ directory at the repo root.

Contents:

  • paper/safestack_paper.tex -- LaTeX source (from the working project.tex); 11 pages, compiles clean (0 overfull, no undefined refs/citations)
  • paper/safestack_paper.pdf -- compiled PDF, so readers can grab the paper without a LaTeX toolchain
  • paper/fig_dose.pdf, paper/fig_bars.pdf -- the two figures the paper embeds
  • paper/make_figs.py -- figure generator; transcribes committed reports/selection/*.json and the report headline table (no numbers computed beyond plotting), writes next to itself, regenerable via uv run --with matplotlib --with numpy python paper/make_figs.py

Figures were redesigned for clarity and accessibility:

  • Okabe-Ito colorblind-safe palette, plus a secondary encoding (marker shape on the dose lines; hatch textures on the bars) so both survive grayscale printing and residual CVD.
  • Dose-response (H7): equal-spaced ordinal dose axis, direct end-labels, an aligned-floor reference, and a "same data, different objective" gap annotation.
  • Defense-in-depth: legend lifted above the plot to avoid label collisions, selective value labels.

Also:

  • Removes the "Draft for review" marker from the title block.
  • Ignores LaTeX build artifacts in .gitignore while keeping the .tex source and the .pdf.

The portfolio/resume-framed project.md stays local (the README is the public overview).

Gate: ruff check . clean; pytest -m 'not hf' 435 passed, 4 skipped.

Closes #209

Add the submittable LaTeX write-up of the study as a standalone paper/
directory at the repo root:

- safestack_paper.tex  -- LaTeX source (from the working project.tex)
- safestack_paper.pdf  -- compiled PDF (read without a LaTeX toolchain)
- fig_dose.pdf, fig_bars.pdf -- embedded figures
- make_figs.py -- figure generator (transcribes reports/selection/*.json)

Drop the "Draft for review" marker from the title block. Ignore LaTeX
build artifacts in .gitignore while keeping the .tex source and .pdf.

The portfolio/resume-framed project.md stays local (README is the
public overview).

Closes #209
@github-actions

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

209 - PR Code Verified

Compliant requirements:

  • Add the LaTeX source at paper/safestack_paper.tex.
  • Add a figure generator using transcribed study results.
  • Remove the "Draft for review" marker from the title block.
  • Leave project.md out of the supplied changes.

Requires further human verification:

  • Verify that the paper compiles and its rendered layout is suitable for submission.
  • Verify that the source corresponds to the working project.tex.
  • Confirm that the compiled paper and both figure PDFs are committed; binary changes are not shown in the supplied diff.
  • Check the transcribed figure values against the referenced committed artifacts.
  • Confirm that .gitignore contains the requested LaTeX auxiliary-file patterns; its changes are not shown in the supplied diff.
⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

@kambleakash0
kambleakash0 merged commit 440a7f9 into main Sep 13, 2026
3 checks passed
@kambleakash0
kambleakash0 deleted the docs/latex-paper-209 branch September 13, 2026 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add formal LaTeX paper under paper/

1 participant