feat: 0.7.0 layered public api, tutorials, and docs refresh#65
Merged
Conversation
a94e935 to
4de1293
Compare
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
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.
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 (newplotsim.types,plotsim.debug,plotsim.inspectdeprecation 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.ymlnav, CHANGELOG[0.7.0]consolidation,plotsim-schema.jsonregen, plus copy-edit pass across the remainder ofplotsim/andtests/)Use GitHub's "Files changed" tab for the full per-file diff.
How to test