docs(workshop): refine IDETC participant notebook - #77
Merged
mkeeler43 merged 9 commits intoAug 20, 2026
Merged
Conversation
mkeeler43
added a commit
that referenced
this pull request
Aug 22, 2026
case.help() printed 125 lines, and the reference half of it was the half
nobody could read: prose paragraphs, the murder-mystery vocabulary doing
work it could not do ("one question, every suspect"), and argument tables
that had to be assembled into a call before they could be used.
It now prints 28 lines and nothing else -- the five calls, then one line
per form of evaluate and show, each with its result in a column at 42 and
its default flush right at 77. Every how= value is a runnable line rather
than a value you have to work into a call yourself. The only sentence left
is the fragment-matching rule, which is not guessable from anything else.
The reference material is real, so it moved rather than went: controls,
the space map, every keyword with its default, and the raw arrays are
behind case.help(full=True), under a header saying it is not needed for
the session. full is keyword-only, so every existing case.help() call
keeps working.
Checked rather than eyeballed: every metric named in the sheet is
registered and configured for beams2d, every case.* method exists, every
keyword matches the signature it belongs to, and volfrac is the spec's
volume_condition. Nothing exceeds 80 columns.
build_notebook.py also picks up a ruff format fix it arrived with in #77,
which pre-commit does not exclude and would have failed on next commit.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
mkeeler43
added a commit
that referenced
this pull request
Aug 22, 2026
Two notes from the supervisor's read-through. The Setup heading said nothing about cost, so a participant watching a silent pip install has no way to tell a slow cell from a hung one. Measured on Colab: about a minute to install, about 45 seconds to open the case and pull the dataset. The performance section named iog, cog and fog only in lower case, inside a sentence that then repeated itself after #77 appended definitions to it. They are acronyms, so they are capitalised where the concept is named and left lower case where the column is -- `case.evaluate("cog")` takes the string. A table separates the two rather than mixing them mid-sentence. Both directions checked against the registry: all three are higher_is_better=False and cost="expensive", which is what the cell now claims. Co-Authored-By: Claude Opus 5 (1M context) <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
2 participants
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
feat/idetc26-workshopso they remain valid after mergetools/build_notebook.pyVerification
ruff check workshops/idetc26/tools/build_notebook.pypython -B -m py_compile workshops/idetc26/tools/build_notebook.pyPYTEST_DISABLE_PLUGIN_AUTOLOAD=1 python -m pytest -q tests/test_idetc26.py: 27 passed; 19 setup errors because the sandbox could neither write the existing Hugging Face cache lock nor reach the Hub