Add user onboarding Jupyter notebooks for BuildCompiler#84
Add user onboarding Jupyter notebooks for BuildCompiler#84Gonza10V wants to merge 2 commits intofull_buildfrom
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b569decffa
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": "# Option A (recommended): uv\n# !uv sync --all-groups\n\n# Option B: pip\n# !python -m venv .venv\n# !source .venv/bin/activate\n# !python -m pip install -U pip\n# !python -m pip install -e ." |
There was a problem hiding this comment.
Use interpreter-targeted pip commands in notebook setup
The Option B setup sequence relies on !source .venv/bin/activate, but in Jupyter each ! invocation runs in its own subshell, so the activation does not persist to the later pip commands. Users who uncomment this cell will often install dependencies into the wrong interpreter (or global env), which can make the subsequent import check fail and undermines reproducibility. Prefer %pip in-notebook, or call !./.venv/bin/python -m pip ... directly.
Useful? React with 👍 / 👎.
Motivation
index_collections,domestication,assembly_lvl1,assembly_lvl2,transformation,plating,full_build) so users can run planning-only or full-build workflows with explicit dependencies.BuildOptionsto encourage deterministic, auditable runs.Description
notebooks/:01_install_and_setup.ipynb,02_planning_only_quickstart.ipynb,03_full_build_minimal.ipynb,04_options_and_safety.ipynb, and05_stage_by_stage_guide.ipynbthat contain explanatory markdown and small example code snippets referencing the public API.notebooks/notebooks.mdto index the new guides and describe their purpose for users browsing the folder.Testing
python -m json.tool notebooks/01_install_and_setup.ipynb, which succeeded.python -m json.tool notebooks/05_stage_by_stage_guide.ipynb, which succeeded.Codex Task