Skip to content

Move the roadmap's informal items to issues, and link solprop - #39

Merged
jtravs merged 4 commits into
mainfrom
docs/roadmap-to-issues
Nov 4, 2026
Merged

jtravs merged 4 commits into
mainfrom
docs/roadmap-to-issues

Conversation

@jtravs

@jtravs jtravs commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Third of three PRs bringing optmat up to solprop's standards, and the one that does most of the solprop cross-referencing. It's stacked on #38, so retarget it to main once #9 and #38 have merged.

What changed

  • docs/roadmap.md: cut from 442 lines to 73: the accepted and draft OEP lists, plus a note saying where everything went, with a permalink to the old page.
  • docs/wanted.md: new, holding Papers and data we are looking for word for word apart from its intro. It's about 150 lines of citations for outside readers, so it stays one page with one umbrella issue (Papers and data we are looking for #31) rather than about 60 small issues. This is a judgement call and easy to reverse.
  • docs/propagation.md: a new solprop section names it as the worked example of this interface, and links its manual and SEPs 3, 6, 11 and 17.
  • docs/introduction/overview.md: now names solprop, which it didn't before.
  • Pointers: README, overview, the accuracy pages, two-photon page, testing page, developers index and OEP index now point at the issues or the new page.
  • OEPs 7 and 8: name their tracking issues (OEP 7: Strong-field dissociation of small molecules: the products a pulse leaves #35, OEP 8: The bound two-photon resonances of the noble gases for propagation #36). Draft OEP 8 links SEP 17 and the issues in place of "on the roadmap".
  • docs/gallery/_helpers.py: solprop's old values are now described as former, not current.

Every roadmap item

Roadmap item Now
VUV RDW suppression #10
Beyond OEP 8's first scope #11
Raman and ionisation parameters: done items dropped, already in the manual
… ionisation rates, reference rates #12
… N2O rotations, H2/D2 energies and gain excess, Q-branch widths #13
… Q-branch line mixing #14
… structure coefficients, cation polarizabilities #16
Molecules in the EUV #17
Infrared beyond OEP 3 #18
Completing the curated records #19
High pressure #20
solprop section status moved to docs/propagation.md, "never depends" to AGENTS.md (#9)
Solids: fused silica summary dropped, already in docs/silica.md
Two-photon absorption #21
Ionisation and damage #22
Temperature #23
More materials #24
Silicon, further #25
Catalogues #26
Silica's open questions #27
Crystals #28
Read-only registries #29
Numerical regression across platforms #30
Releases; Continuous integration dropped: stale, both shipped in 0.8.0
Papers and data we are looking for docs/wanted.md, #31

Issues found along the way, not from the roadmap: #15 (Raman collision partners, for LupoLab/solprop#285), #32 (LupoLab/solprop#166), #33 (CI cost), #34 (retire tools/solprop_*.py), #37 (sdist built under .claude/).

Left alone on purpose

  • REGISTER.md, CHANGELOG.md history and Final OEPs: they are records.
  • Source records and data/gas/*.toml: a few say "requested (roadmap)", but editing them would change catalogue entries and possibly digests. The roadmap's note covers them.
  • The old against-solprop anchors, so inbound links keep working.
  • No solprop intersphinx entry: there are too few links to justify an offline inventory.

Verified

Not checked: issue text transcribed from the roadmap wasn't re-checked against the code or papers, and each of those issues says so.

🤖 Generated with Claude Code

jtravs and others added 3 commits November 4, 2026 11:06
The roadmap now lists only accepted and draft OEPs. Its items are issues #10
to #31, the papers wanted have their own page, and the pages that pointed at
the roadmap point at those. OEPs 7 and 8 name their tracking issues.

The propagation page gains a section on solprop as the worked example of its
interface, with links to its manual and SEPs, and the overview names it. The
gallery helpers now describe solprop's old values as former, not current.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 4, 2026 11:22
@jtravs jtravs added the documentation Improvements or additions to documentation label Nov 4, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-04T11:24:31.082320Z 8334623 PR opened
🔒 Security Review ✅ Completed 2026-11-04T11:25:17.864460Z 8334623 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@codecov

codecov Bot commented Nov 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@jtravs
jtravs changed the base branch from chore/changelog-fragments to main November 4, 2026 13:01
@jtravs
jtravs merged commit 4289f28 into main Nov 4, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant