Release prep: remove manuscripts from repo, packaging metadata, CI, CITATION - #3
Merged
Merged
Conversation
The manuscripts (PMB paper and physics derivation) are distributed separately via arXiv and should not live in the software repository. - Untrack paper/ and docs/ (git rm --cached; files remain on disk) and add both to .gitignore so the repo ships only the software: src/, tests/, validation/, examples/. - pyproject: add [project.urls], PyPI classifiers, and keywords. - Expose shearwave.__version__ (importlib.metadata, with a source fallback). - Add GitHub Actions CI (pytest on Python 3.10-3.12 with the JAX CPU backend). - Add CITATION.cff (software + the paper, cited by DOI once available) and CONTRIBUTING.md. Note: this removes the manuscripts from HEAD only; they remain in git history. If the repository is made public before the paper is released, history should be scrubbed (e.g. git filter-repo) to avoid publishing the manuscript early. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01R3eMurRYQsmx58nU2yFwAF
gfpinton
force-pushed
the
release-prep/quick-blockers
branch
from
July 19, 2026 06:10
d7abc86 to
1c6b1de
Compare
gfpinton
changed the title
gfpinton
added a commit
that referenced
this pull request
Jul 19, 2026
Release prep: remove manuscripts from repo, packaging metadata, CI, CITATION
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prepares the repo for a public software release.
Manuscripts removed from the repo — the PMB paper and physics-derivation document are distributed separately via arXiv.
paper/anddocs/are untracked (git rm --cached; files remain on disk) and added to.gitignore, so the repository ships only the software:src/,tests/,validation/,examples/.Packaging / release polish:
pyproject.toml:[project.urls], PyPIclassifiers,keywordsshearwave.__version__exposed (importlib.metadata + source fallback)pyteston Python 3.10–3.12 with the JAX CPU backend (so parity tests run)CITATION.cffandCONTRIBUTING.mdThis removes the manuscripts from
HEADonly — they remain in git history. If the repo is made public before the paper is released, history should be scrubbed (e.g.git filter-repo) so the manuscript isn't published early. Flagging for a decision.Superseded
An earlier version of this branch parametrized the
paper/generate_fig_*.pyhardcoded paths; that's moot now thatpaper/is untracked (the improved scripts remain on disk for local use).Left for a separate decision
Test plan
pytest tests/— 24 passed (with JAX)uv build— wheel + sdist build with new metadatashearwave.__version__resolvespaper/anddocs/untracked but preserved on disk🤖 Generated with Claude Code
https://claude.ai/code/session_01R3eMurRYQsmx58nU2yFwAF