Skip to content

feat: 0.7.0 layered public api, tutorials, and docs refresh#65

Merged
mohossam01 merged 4 commits into
mainfrom
refactor/0_7_0-pr3
May 22, 2026
Merged

feat: 0.7.0 layered public api, tutorials, and docs refresh#65
mohossam01 merged 4 commits into
mainfrom
refactor/0_7_0-pr3

Conversation

@mohossam01
Copy link
Copy Markdown
Owner

@mohossam01 mohossam01 commented May 20, 2026

What this PR does

Adds plotsim.run() as an end-to-end pipeline that builds, generates, validates, and writes a dataset in one call. Lays out the public API across three namespaces — workflow (plotsim.*), types (plotsim.types), and debug (plotsim.debug) — so it is clearer which symbols you reach for when. Refreshes the docs site with a redesigned user guide, six template-specific guides, and three end-to-end tutorial notebooks, and releases as 0.7.0.

Files Modified

Four commits on top of main:

  • chore: bump version to 0.7.0 — 2 files (pyproject.toml, plotsim/init.py)
  • feat: restore PlotsimConfig.from_yaml and route engine yaml through it — 4 files (cli, config, output, test_cli)
  • feat: layer the public api into workflow, types, and debug namespaces — 54 files (new plotsim.types, plotsim.debug, plotsim.inspect deprecation shim; ~47 test files for import rewires and behavior coverage)
  • docs: refresh docs site for 0.7.0 — 133 files (full docs site overhaul, new tutorial notebooks, mkdocs.yml nav, CHANGELOG [0.7.0] consolidation, plotsim-schema.json regen, plus copy-edit pass across the remainder of plotsim/ and tests/)

Use GitHub's "Files changed" tab for the full per-file diff.

How to test

python -m pytest
python -m mypy plotsim/

@mohossam01 mohossam01 force-pushed the refactor/0_7_0-pr3 branch from a94e935 to 4de1293 Compare May 22, 2026 08:00
@mohossam01 mohossam01 merged commit 62d159e into main May 22, 2026
6 checks passed
@mohossam01 mohossam01 deleted the refactor/0_7_0-pr3 branch May 22, 2026 08:17
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.

1 participant