docs+feat: README discoverability, rvctool defaults, bdsim model CLI access - #47
Open
petercorke wants to merge 1 commit into
Open
docs+feat: README discoverability, rvctool defaults, bdsim model CLI access#47petercorke wants to merge 1 commit into
petercorke wants to merge 1 commit into
Conversation
…lts, bdsim model CLI access README: - Fix 3 broken links in "Additional book resources" (pointclouds, 3dfigures, examples all pointed at nonexistent top-level folders -- real paths are figures/pointclouds, figures/3d, RVC3/examples). - Move "Additional book resources" up to right after "Installing the package", so "pip install gets you the library, clone the repo for notebooks/figures" isn't buried as the very last section of a 325-line file. - Add a one-line pointer to that section right after the install instructions, and a top-of-file [!NOTE] banner flagging this pass of fixes, linking errata.md. - Rewrite "Block diagram models" to document all three ways to run a model (rvctool %run -i, the new rvc3-model command, bdsim_path to locate the install folder) instead of just one, and fix its own %run -m -> %run -i staleness. rvctool: replace the confusing -n/--normal (dest="book", inverted sense) with a direct --book/--no-book pair. Defaults changed so a plain `rvctool` now gives a nicer interactive experience by default (RVC3 >>> prompt, Out[N]: labels shown, ANSImatrix on, cwd to examples) rather than the old book-print-fidelity defaults; --book now narrowly means "match the printed page exactly" (plain '>>> ', no Out[N]:, no ANSI). Also fixes a real bug: book mode used to overwrite --prompt unconditionally even when explicitly passed, silently breaking the tool's own documented RVCTOOL_OPTIONS example. Removed the now-dead args.prompt is None branch in MyPrompt (prompt always has a real default now). New: RVC3/models/__init__.py, RVC3/bin/__init__.py -- both packages were implicit namespace packages (no __init__.py despite being explicitly listed in pyproject.toml's packages=[...]), which is why bdsim_path.py's own Path(models.__file__) crashed (namespace packages have __file__ = None). Restored bdsim_path.py from UNTRACKED/ (it had existed there, uncommitted, for years -- the pyproject.toml [project.scripts] entry pointing at it has never actually worked in any real install until now). New: rvc3-model command (RVC3/bin/rvc3_model.py) -- runs a named model from RVC3/models/ directly from a bare shell, no rvctool/Jupyter session needed. Adds the models directory to sys.path first so sibling imports some models use (e.g. `from vloop import vloop, B`) still resolve. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.
Summary
Note: based on
fix/notebook-errata(#45), notmain-- retarget tomainonce that merges, since this branch was cut from its tip and the diff will stay clean once those commits land there.Triggered by "how does a user find the notebooks/figures after
pip install?" -- turned into a broader pass on README clarity,rvctool's prompt defaults, and actually making bdsim models runnable from a bare shell.README:
pointclouds,3dfigures,examplesall pointed at nonexistent top-level folders -- real paths arefigures/pointclouds,figures/3d,RVC3/examples)[!NOTE]banner linkingerrata.mdrvctool %run -i, the newrvc3-modelcommand,bdsim_pathto locate the install folder)rvctool: replaced the confusing-n/--normal(dest="book", inverted sense) with a direct--book/--no-bookpair. Defaults changed so a plainrvctoolgives a nicer interactive experience (RVC3 >>>prompt,Out[N]:labels shown, ANSImatrix on, cwd to examples) rather than the old book-print-fidelity defaults;--booknow narrowly means "match the printed page exactly" (plain>>>, noOut[N]:, no ANSI). Also fixes a real bug: book mode used to overwrite--promptunconditionally even when explicitly passed, silently breaking the tool's own documentedRVCTOOL_OPTIONSexample.New
RVC3/models/__init__.py,RVC3/bin/__init__.py: both packages were implicit namespace packages (no__init__.pydespite being explicitly listed inpyproject.toml'spackages=[...]), which is whybdsim_path.py's ownPath(models.__file__)crashed (namespace packages have__file__ = None). Restoredbdsim_path.pyfromUNTRACKED/-- it had existed there, uncommitted, for years; thepyproject.toml[project.scripts]entry pointing at it has never actually worked in any real install until now.New
rvc3-modelcommand: runs a named model fromRVC3/models/directly from a bare shell, norvctool/Jupyter session needed. Adds the models directory tosys.pathfirst so sibling imports some models use still resolve. (Running it standalone against all models surfaced the missing-imports bug fixed in #46.)Test plan
rvctool --test-- 6/6 checks passrvc3-model vloop_testandbdsim_pathboth work as installed console commands