2.6 KiB
First Run
Use this the first time you open the platform, or anytime you want a clean local restart.
Checklist
-
If this is a fresh Mac or a fresh clone, bootstrap the repo first:
bash ./scripts/app.sh bootstrap -
Check the local state:
bash ./scripts/app.sh status bash ./scripts/app.sh validate --quick -
Start the repo-local server:
bash ./scripts/app.sh start --openIf JupyterLab later looks haunted by old tabs or stale session state, reset the repo-local Jupyter state and start again:
bash ./scripts/app.sh reset-state bash ./scripts/app.sh start --open -
Open the localhost URL printed by the script. It should land on
notebooks/START_HERE.ipynb. -
Confirm the kernel in the top-right corner is
QuantumLearning (.venv). -
Run the cells in
START_HERE.ipynbfrom top to bottom and follow its explicit next-notebook handoff toCOURSE_BLUEPRINT.ipynb. -
From that point onward, do not guess from the filesystem. Follow the explicit next-notebook navigation inside each notebook.
-
The required mainline flow is:
START_HERE.ipynb -> COURSE_BLUEPRINT.ipynb -> foundations -> qiskit_engineering -> algorithms -> professional -> COURSE_COMPLETE.ipynb -
Inside every module, the required local flow is:
lecture.ipynb -> lab.ipynb -> problems.ipynb -> studio.ipynb -
Inside every notebook, complete the
MANDATORYcells in order. TreatFACULTATIVEcells as optional extensions only. -
METAcells are route/objective/pacing guidance, not the technical payload. They are intentionally colored differently inside the notebooks. -
The route notebooks
START_HERE,COURSE_BLUEPRINT, andCOURSE_COMPLETEshould not contain facultative detours.
Expected Local Behavior
- Everything runs from the repo-local
.venv. - Jupyter config, runtime files, and notebook settings stay inside this project.
- The launcher hides the broken machine-level Homebrew
nodepath so JupyterLab starts cleanly on this machine. - No IBM token is required for the main workflow.
- The
Foundations,Qiskit Engineering,Algorithmic Design, andProfessional Designbands are rebuilt intoLecture / Lab / Problems / Studiobundles on top of a professional apprenticeship model. - Difficulty
1-3is reserved for mandatory cells. Difficulty4-10appears only on facultative extensions.
Smoke Check
If you want a quick terminal check before opening the browser:
bash ./scripts/app.sh validate --quick
For the full operational guide, see OPERATIONS.md.