Skip to content

docs: JOSS paper for PyAutoLens-Assistant#71

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/pyautolens-assistant-joss-paper
Jul 15, 2026
Merged

docs: JOSS paper for PyAutoLens-Assistant#71
Jammy2211 merged 1 commit into
mainfrom
feature/pyautolens-assistant-joss-paper

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Adds paper/ — the JOSS manuscript for PyAutoLens-Assistant: Using Natural Language and AI to Analyse Gravitational Lenses — hosted with the software it describes, mirroring the PyAutoLens-JAX sibling in PyAutoLens/paper_jax/.

The drafted prose previously lived only in the PyAutoMind prompt file. This consolidates it into a real manuscript:

  • paper/paper.md — JOSS front-matter + Summary, Statement of need, Software design, Benchmark examples, AI usage disclosure. State of the field and Research impact statement are left as commented stubs; both require author judgement and neither can be evidenced by the repo today.
  • paper/paper.bib — 6 entries, copied verbatim from wiki/literature/bibliography/autolens_literature.bib so the paper and the literature wiki cannot drift apart.
  • paper/README.md — drafting checklist + Inara build command.
  • paper/.gitignore — excludes the local paper.pdf build output.

Decisions

  • Benchmarks framed as "three representative examples." The repo ships four prompts; the fourth (hard_group_multi.md) is intentionally not described. This resolves the drafting note in the original prompt (author chose reframing over adding a fourth paragraph) and is recorded in the README so the two stay consistent.
  • Benchmark-results prose is future-tense, because benchmarks/RESULTS.md currently records zero runs for all four benchmarks. The paper does not claim results the repository cannot evidence. Flagged on the README checklist.
  • SLACS0946+1006SDSSJ0946+1006 to match the cited papers (Vegetti2010, Minor2021) and the literature wiki.
  • Author block mirrors the JAX paper (sole corresponding author); "confirm full author list" is on the checklist.

Scripts Changed

None — documentation only. This PR adds four files under paper/ and touches no scripts, notebooks, configs, or library source.

Test Plan

  • make validate-literature-citations — passes (Citation metadata is valid.)
  • python autoassistant/audit_skill_apis.py — passes (58 files, 120 symbols, 0 missing/broken)
  • Every citation key in paper.md resolves against paper.bib (6 cited, 6 defined, 0 missing, 0 unused)
  • Body word count 1309 — inside the JOSS 750–1750 target
  • YAML front-matter parses; all required JOSS keys present
  • Inara PDF build not run — Docker is unavailable in this environment. Build locally before submission (command in paper/README.md).

Notes

No pending-release label: that label does not exist on this repo, is not covered by ensure_workspace_labels.sh, and recent merged PRs (#70, #68, #66) carry no labels. It guards the library-first merge gate, which does not apply to a docs-only change with no upstream library PR.

Heart at ship time: YELLOW (score 55, no RED), acknowledged by the author. Reasons are pre-existing and unrelated to this docs-only change: workspace validation not passing (3 failed, 2026-07-09T09-48-30Z), 58 stale parked script(s).

Closes #69

Generated by the PyAutoLabs agent workflow.

Add paper/ holding the JOSS manuscript, hosted with the software it
describes and mirroring the PyAutoLens-JAX sibling in PyAutoLens/paper_jax/.

Consolidates the author's drafted Summary, Statement of need, software
design and benchmark sections into a single manuscript, adds the JOSS
front-matter, and stubs the State of the field and Research impact
sections that require author judgement.

Bibliography entries are copied verbatim from the assistant literature
bibliography so the paper and the wiki cannot drift apart.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Jammy2211
Jammy2211 merged commit 3b5349f into main Jul 15, 2026
1 check passed
@Jammy2211
Jammy2211 deleted the feature/pyautolens-assistant-joss-paper branch July 15, 2026 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: scaffold PyAutoLens-Assistant JOSS paper

1 participant