Move the runnable examples to the website - #207
Merged
Conversation
The example scripts (database conversion, ingredient substitution, feed ratio, classification exploration) now live as documented, runnable pages at https://www.volca.run/examples/, maintained and validated against the current engine there. The README's See-also entry points at that page, and test_examples.py follows the converter script out of the tree.
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.
Why
The
pyvolca/examples/scripts were only useful when run against a live engine with real databases, and they kept drifting:feed_ratio.pystill importedvolca.analysis, which no longer exists, and the substitution scripts predated the 0.9 wire renames. Their new home is the website, where each example is published as a documented page, kept runnable, and validated against the current engine — https://www.volca.run/examples/.Final state
pyvolca/examples/is gone (five scripts), andtests/test_examples.pyfollows the converter script it exercised.Full pyvolca suite after removal: 227 passed, 7 skipped (engine-drift tests, no local binary).