Skip to content

Add docs site, benchmark script and PyPI release workflow - #18

Merged
aeberspaecher merged 1 commit into
mainfrom
claude/project-thread-3vpgth
Oct 25, 2026
Merged

aeberspaecher merged 1 commit into
mainfrom
claude/project-thread-3vpgth

Conversation

@aeberspaecher

Copy link
Copy Markdown
Owner

Requested by Alex · project thread

Item A6 of the next-steps plan.

Changes

  • Docs site: MkDocs Material and mkdocstrings (numpy style) build the docs. docs/index.md pulls in the README, and there is one API page per module. Math in the docstrings is rendered by MathJax. mkdocs build --strict passes.
  • Pages: jupyterlite.yml becomes pages.yml. It builds the docs at the site root and JupyterLite under lite/, because GitHub Pages serves one site per repository.
  • Benchmark: benchmarks/benchmark.py times steps for 1d and 2d grids. Columns are complex128 and complex64 at order 2, plus complex128 at order 4. Options are --quick, --pyfftw, --workers, --steps and --repeat. Output with --quick here:
    grid           complex128, order 2    complex64, order 2   complex128, order 4
    1d 2048                    38.0 µs               25.9 µs              116.4 µs
    2d 256x256                1.027 ms              718.0 µs              2.922 ms
    2d 512x512                3.393 ms              1.952 ms             11.151 ms
    
  • PyPI: a new release.yml.
    • On every PR it builds the sdist and wheel and runs twine check --strict.
    • When a GitHub release is published, it uploads them with trusted publishing (environment pypi). No token is stored in the repo.
  • Packaging:
    • Version 0.5.0 in pyproject.toml and __init__.py.
    • CHANGELOG.md covers everything since 0.4.0; the version notes that were in the README moved there.
    • Keywords, classifiers, project URLs and a docs extra.
    • The README LICENSE link is now absolute, so it works on PyPI.
  • README: a docs badge, pip install so_schroedinger, and short Documentation and Releases sections.

One-time setup before the first release

  1. On PyPI, add a pending trusted publisher for so_schroedinger (the name is still free). Owner aeberspaecher, repo splitoperator, workflow release.yml, environment pypi.
  2. After merging, publish a GitHub release with tag v0.5.0.

Tests

  • mkdocs build --strict is clean. I checked the rendered API pages in headless Chromium.
  • python -m build and twine check --strict pass for both distributions.
  • The benchmark runs.
  • The test suite passes (75 tests without the notebook run; no library code changed). ruff check and ruff format --check are clean.

Generated by Claude Code

- MkDocs (Material + mkdocstrings) API docs from the docstrings, published
  with the JupyterLite notebooks (now under lite/) by one pages workflow
- benchmarks/benchmark.py times steps for 1d/2d grids, both precisions
  and orders 2 and 4
- release workflow: builds and checks sdist and wheel on PRs, uploads to
  PyPI with trusted publishing when a GitHub release is published
- version 0.5.0, CHANGELOG.md, PyPI metadata

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BSqcCcd888TDDSg17G2Hyu
@aeberspaecher aeberspaecher self-assigned this Oct 25, 2026
@aeberspaecher
aeberspaecher merged commit 73ce539 into main Oct 25, 2026
10 checks passed
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.

2 participants